Introduction

Core resources

Administration

Invite member

Revoke member

Booking flow

Contacts

Endpoints

GET/contactsPOST/contactsDELETE/contactsPATCH/contacts

The contact object

Attributes

iduuid

Unique identifier

creator_iduuid | null

user_profiles.user_id

Identifier of the user that created the contact

organization_iduuid

Identifier of the organization this contact is defined in

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

addresstext

Concatenation of the address fields

avatartext | null

URL of the avatar image

citytext

City of the contact

countrytext

Country of the contact

emailtext

Contact email address

first_nametext

First name of the contact

ftstsvector

Full text search index

languagetext | null

Language of the contact

last_nametext

Last name of the contact

metajsonb

nametext

Full name of the contact

notestext

phonetext

Contact phone number

provincetext

Province of the contact

statetext

State of the contact

streettext

Street address of the contact

street2text

Street address of the contact

ziptext

Zip code of the contact

The contact object

{"id": "00000000-0000-0000-0000-000000000000",
"creator_id": "00000000-0000-0000-0000-000000000000",
"organization_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-11-21T14:03:52.202Z",
"updated_at": "2024-11-21T14:03:52.202Z",
"address": "",
"avatar": "",
"city": "",
"country": "",
"email": "",
"first_name": "",
"language": "",
"last_name": "",
"meta": {},
"name": "",
"notes": "",
"phone": "",
"province": "",
"state": "",
"street": "",
"street2": "",
"zip": ""
}

List contacts

Filters

idFilter<>

Unique identifier

creator_idFilter<>

Identifier of the user that created the contact

organization_idFilter<>

Identifier of the organization this contact is defined in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

addressFilter<>

Concatenation of the address fields

avatarFilter<>

URL of the avatar image

cityFilter<>

City of the contact

countryFilter<>

Country of the contact

emailFilter<>

Contact email address

first_nameFilter<>

First name of the contact

ftsFilter<>

Full text search index

languageFilter<>

Language of the contact

last_nameFilter<>

Last name of the contact

metaFilter<>

nameFilter<>

Full name of the contact

notesFilter<>

phoneFilter<>

Contact phone number

provinceFilter<>

Province of the contact

stateFilter<>

State of the contact

streetFilter<>

Street address of the contact

street2Filter<>

Street address of the contact

zipFilter<>

Zip code of the contact

Responses

200

A list of contacts with the selected columns

206

Partial Content

GET/contacts

curl -X GET "https://api.bookingmood.com/v1/contacts?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create contacts

Body

Partial<Contact>
 | Array<Partial<Contact>>

Responses

201

The newly created contacts with the selected columns

POST/contacts

curl -X POST "https://api.bookingmood.com/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[]'

Delete contacts

Filters

idFilter<>

Unique identifier

creator_idFilter<>

Identifier of the user that created the contact

organization_idFilter<>

Identifier of the organization this contact is defined in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

addressFilter<>

Concatenation of the address fields

avatarFilter<>

URL of the avatar image

cityFilter<>

City of the contact

countryFilter<>

Country of the contact

emailFilter<>

Contact email address

first_nameFilter<>

First name of the contact

ftsFilter<>

Full text search index

languageFilter<>

Language of the contact

last_nameFilter<>

Last name of the contact

metaFilter<>

nameFilter<>

Full name of the contact

notesFilter<>

phoneFilter<>

Contact phone number

provinceFilter<>

Province of the contact

stateFilter<>

State of the contact

streetFilter<>

Street address of the contact

street2Filter<>

Street address of the contact

zipFilter<>

Zip code of the contact

Responses

204

The deleted contacts with the selected columns

DELETE/contacts

curl -X DELETE "https://api.bookingmood.com/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update contacts

Filters

idFilter<>

Unique identifier

creator_idFilter<>

Identifier of the user that created the contact

organization_idFilter<>

Identifier of the organization this contact is defined in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

addressFilter<>

Concatenation of the address fields

avatarFilter<>

URL of the avatar image

cityFilter<>

City of the contact

countryFilter<>

Country of the contact

emailFilter<>

Contact email address

first_nameFilter<>

First name of the contact

ftsFilter<>

Full text search index

languageFilter<>

Language of the contact

last_nameFilter<>

Last name of the contact

metaFilter<>

nameFilter<>

Full name of the contact

notesFilter<>

phoneFilter<>

Contact phone number

provinceFilter<>

Province of the contact

stateFilter<>

State of the contact

streetFilter<>

Street address of the contact

street2Filter<>

Street address of the contact

zipFilter<>

Zip code of the contact

Body

Partial<Contact>

Responses

204

The updated contacts with the selected columns

PATCH/contacts

curl -X PATCH "https://api.bookingmood.com/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'