Introduction

Core resources

Administration

Invite member

Revoke member

Booking flow

User profiles

Endpoints

GET/user_profilesPATCH/user_profiles

The user profile object

Attributes

user_iduuid

Unique identifier

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

avatartext | null

URL of the avatar image

emailtext

User email address

first_week_contains_datesmallint | null

First week of the year. Either 1 (first week with a Thursday) or 4 (first week with a Monday)

ftstsvector

Full text search index

last_login_attimestamp with time zone | null

Timestamp at which the user last logged in

localetext

User language

nametext | null

User name

referred_bytext | null

Identifier of the user that referred this user

sourcetext | null

Source of the user

week_starts_onsmallint | null

First day of the week. Either 1 or 0

The user profile object

{"user_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-05-11T10:07:53.814Z",
"updated_at": "2024-05-11T10:07:53.814Z",
"avatar": "",
"email": "",
"first_week_contains_date": 0,
"last_login_at": "2024-05-11T10:07:53.814Z",
"locale": "en-US",
"name": "",
"referred_by": "",
"source": "",
"week_starts_on": 0
}

List user profiles

Filters

user_idFilter<uuid>

Unique identifier

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

avatarFilter<text>

URL of the avatar image

emailFilter<text>

User email address

first_week_contains_dateFilter<smallint>

First week of the year. Either 1 (first week with a Thursday) or 4 (first week with a Monday)

ftsFilter<tsvector>

Full text search index

last_login_atFilter<timestamp with time zone>

Timestamp at which the user last logged in

localeFilter<text>

User language

nameFilter<text>

User name

referred_byFilter<text>

Identifier of the user that referred this user

sourceFilter<text>

Source of the user

week_starts_onFilter<smallint>

First day of the week. Either 1 or 0

Responses

200

A list of user profiles with the selected columns

206

Partial Content

GET/user_profiles

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

Update user profiles

Filters

user_idFilter<uuid>

Unique identifier

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

avatarFilter<text>

URL of the avatar image

emailFilter<text>

User email address

first_week_contains_dateFilter<smallint>

First week of the year. Either 1 (first week with a Thursday) or 4 (first week with a Monday)

ftsFilter<tsvector>

Full text search index

last_login_atFilter<timestamp with time zone>

Timestamp at which the user last logged in

localeFilter<text>

User language

nameFilter<text>

User name

referred_byFilter<text>

Identifier of the user that referred this user

sourceFilter<text>

Source of the user

week_starts_onFilter<smallint>

First day of the week. Either 1 or 0

Body

Partial<UserProfile>

Responses

204

The updated user profiles with the selected columns

PATCH/user_profiles

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