# Organization snapshots

Snapshots of the subscriptions of organizations, for reporting

Endpoint: `https://api.bookingmood.com/v1/organization_snapshots`, supporting `GET`. Authenticate with the header `Authorization: Bearer YOUR_API_KEY` (see [authentication](https://www.bookingmood.com/nn-NO/api-reference/authentication.md)).

## The organization snapshot object

| Attribute | Type | Description |
| --- | --- | --- |
| `id` | `uuid` | Unique identifier. |
| `organization_id` | `uuid` | Identifier of the related organization. |
| `created_at` | `timestamp with time zone` | Creation timestamp. Read-only: set by the database. |
| `active` | `boolean` | Whether the organization was active. |
| `number_of_paid_multi_unit_sites` | `int32` | Number of paid catalog sites. |
| `number_of_paid_single_unit_sites` | `int32` | Number of paid single-unit sites. |
| `number_of_products` | `int32` | Number of units. |
| `period` | `SubscriptionPeriod` | Billing period of the subscription. |
| `pricing_version` | `OrganizationPricingVersion` | Version of Bookingmood's pricing that applied to the organization. |
| `subscription_type` | `SubscriptionType` | How the subscription was paid. |
| `tier` | `Tier` | Subscription tier of the organization. |

```json
{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-11-22T16:21:25.278Z",
  "active": false,
  "number_of_paid_multi_unit_sites": 0,
  "number_of_paid_single_unit_sites": 0,
  "number_of_products": 0,
  "period": "monthly",
  "pricing_version": "V1",
  "subscription_type": "duda",
  "tier": "free"
}
```

### Types

```typescript
type OrganizationPricingVersion = "V1" | "V2" | "V3" | "V4" | "V5";

type SubscriptionPeriod = "yearly" | "monthly";

type SubscriptionType = 
  | "test"
  | "trial"
  | "paddle"
  | "pre-paid"
  | "duda"
  | "duda-trial";

type Tier = "free" | "basic" | "plus" | "premium";
```

## List organization snapshots

`GET /v1/organization_snapshots` · requires the `organization:read` scope

Filter on any attribute with `column=operator.value` (see [filtering](https://www.bookingmood.com/nn-NO/api-reference/filtering.md)). Choose columns and embed related resources with `select` (see [selecting](https://www.bookingmood.com/nn-NO/api-reference/selecting.md)), and sort and paginate with `order`, `limit` and `offset` (see [sorting and pagination](https://www.bookingmood.com/nn-NO/api-reference/sorting-pagination.md)).

```bash
curl "https://api.bookingmood.com/v1/organization_snapshots?select=*&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

Responses:

- `200`: A list of organization snapshots with the selected columns. `206` when the list is a partial range.
- `400`: The request is malformed, for example an unknown column or an invalid filter.
- `401`: The API key is missing or invalid.
- `403`: The API key or access token doesn't have the scope this request needs.
- `429`: The API key made more requests per minute than its rate limit allows. Retry after the number of seconds in the `Retry-After` header.

Errors have a JSON body with a `code`, `message`, `details` and `hint`. See the [introduction](https://www.bookingmood.com/nn-NO/api-reference.md) for more on errors. The full API is described by the OpenAPI spec at https://api.bookingmood.com/v1/openapi.json.
