Core resources
Administration
Booking flow
Distinct groups that can occupy units. Useful for configuring separate prices & limits for adult / children / pets.
id
uuid
Unique identifier
organization_id
uuid
Identifier of the organization this occupancy group is defined in
created_at
timestamp with time zone
Creation timestamp
updated_at
timestamp with time zone
Last modification timestamp
description
jsonb
Localized description
name
jsonb
Localized name
name_singular
jsonb
Localized singular name
order
integer
Order of the occupancy group as displayed on widgets and websites
type
"manual" | "sum"
Type of the occupancy group, either manual
or sum
{"id": "00000000-0000-0000-0000-000000000000","organization_id": "00000000-0000-0000-0000-000000000000","created_at": "2024-05-19T15:11:38.175Z","updated_at": "2024-05-19T15:11:38.175Z","description": {},"name": {},"name_singular": {},"order": 1,"type": "manual"}
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this occupancy group is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
description
Filter<jsonb>
Localized description
name
Filter<jsonb>
Localized name
name_singular
Filter<jsonb>
Localized singular name
order
Filter<integer>
Order of the occupancy group as displayed on widgets and websites
type
Filter<"manual" | "sum">
Type of the occupancy group, either manual
or sum
200
A list of occupancy groups with the selected columns
206
Partial Content
GET
/occupancy_groups
curl -X GET "https://api.bookingmood.com/v1/occupancy_groups?select=*" \ -H "Authorization: Bearer YOUR_API_KEY"
Partial<OccupancyGroup>
| Array<Partial<OccupancyGroup>>
201
The newly created occupancy groups with the selected columns
POST
/occupancy_groups
curl -X POST "https://api.bookingmood.com/v1/occupancy_groups" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '[]'
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this occupancy group is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
description
Filter<jsonb>
Localized description
name
Filter<jsonb>
Localized name
name_singular
Filter<jsonb>
Localized singular name
order
Filter<integer>
Order of the occupancy group as displayed on widgets and websites
type
Filter<"manual" | "sum">
Type of the occupancy group, either manual
or sum
204
The deleted occupancy groups with the selected columns
DELETE
/occupancy_groups
curl -X DELETE "https://api.bookingmood.com/v1/occupancy_groups" \ -H "Authorization: Bearer YOUR_API_KEY"
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this occupancy group is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
description
Filter<jsonb>
Localized description
name
Filter<jsonb>
Localized name
name_singular
Filter<jsonb>
Localized singular name
order
Filter<integer>
Order of the occupancy group as displayed on widgets and websites
type
Filter<"manual" | "sum">
Type of the occupancy group, either manual
or sum
Partial<OccupancyGroup>
204
The updated occupancy groups with the selected columns
PATCH
/occupancy_groups
curl -X PATCH "https://api.bookingmood.com/v1/occupancy_groups" \ -H "Authorization: Bearer YOUR_API_KEY" \ -d '{}'