Introduction

Core resources

Administration

Invite member

Revoke member

Booking flow

Occupancy groups

Distinct groups that can occupy units. Useful for configuring separate prices & limits for adult / children / pets.

Endpoints

GET/occupancy_groupsPOST/occupancy_groupsDELETE/occupancy_groupsPATCH/occupancy_groups

The occupancy group object

Attributes

iduuid

Unique identifier

organization_iduuid

Identifier of the organization this occupancy group is defined in

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

descriptionjsonb

Localized description

namejsonb

Localized name

name_singularjsonb

Localized singular name

orderinteger

Order of the occupancy group as displayed on widgets and websites

type"manual" | "sum"

Type of the occupancy group, either manual or sum

The occupancy group object

{"id": "00000000-0000-0000-0000-000000000000",
"organization_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-05-11T11:37:33.626Z",
"updated_at": "2024-05-11T11:37:33.626Z",
"description": {},
"name": {},
"name_singular": {},
"order": 1,
"type": "manual"
}

List occupancy groups

Filters

idFilter<uuid>

Unique identifier

organization_idFilter<uuid>

Identifier of the organization this occupancy group is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

descriptionFilter<jsonb>

Localized description

nameFilter<jsonb>

Localized name

name_singularFilter<jsonb>

Localized singular name

orderFilter<integer>

Order of the occupancy group as displayed on widgets and websites

typeFilter<"manual" | "sum">

Type of the occupancy group, either manual or sum

Responses

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"

Create occupancy groups

Body

Partial<OccupancyGroup>
 | Array<Partial<OccupancyGroup>>

Responses

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 '[]'

Delete occupancy groups

Filters

idFilter<uuid>

Unique identifier

organization_idFilter<uuid>

Identifier of the organization this occupancy group is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

descriptionFilter<jsonb>

Localized description

nameFilter<jsonb>

Localized name

name_singularFilter<jsonb>

Localized singular name

orderFilter<integer>

Order of the occupancy group as displayed on widgets and websites

typeFilter<"manual" | "sum">

Type of the occupancy group, either manual or sum

Responses

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"

Update occupancy groups

Filters

idFilter<uuid>

Unique identifier

organization_idFilter<uuid>

Identifier of the organization this occupancy group is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

descriptionFilter<jsonb>

Localized description

nameFilter<jsonb>

Localized name

name_singularFilter<jsonb>

Localized singular name

orderFilter<integer>

Order of the occupancy group as displayed on widgets and websites

typeFilter<"manual" | "sum">

Type of the occupancy group, either manual or sum

Body

Partial<OccupancyGroup>

Responses

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 '{}'