List guests

GET

/v1/guests

curl --request GET \
  --url https://api.useservice.app/v1/guests \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• api_key

Parameters

Query Parameters

vip

boolean

blacklisted

boolean

phone

string

Normalized to E.164 before matching

email

string

query

string

Substring match on name/email

updated_since

string

limit

integer

starting_after

string

ending_before

string

Responses

200

Guests listed

Media type application/json

object

object

required

string

Allowed values: list

data

required

Array<object>

object

object

required

string

Allowed values: guest

id

required

string

first_name

string

nullable

last_name

required

string

email

string

nullable

phone

string

nullable

notes

string

nullable

blacklisted

required

boolean

blacklist_reason

string

nullable

dietary_preferences

required

Array<string>

allergies

required

Array<string>

birthday

string format: date

nullable

anniversary

string format: date

nullable

vip

required

boolean

language

string

nullable

Allowed values: fr en de es it nl pt da sv no fi

source

required

string

Allowed values: manual widget import

marketing_email_consent

required

boolean

marketing_email_consent_at

string format: date-time

nullable

marketing_sms_consent

required

boolean

marketing_sms_consent_at

string format: date-time

nullable

visit_count

required

integer

no_show_count

required

integer

cancellation_count

required

integer

first_visit_at

string format: date-time

nullable

last_visit_at

string format: date-time

nullable

created_at

required

string format: date-time

updated_at

required

string format: date-time

has_more

required

boolean

Example

{
  "object": "list",
  "data": [
    {
      "object": "guest",
      "language": "fr",
      "source": "manual"
    }
  ]
}

Headers

Service-Version

string

Dated API version applied to this response

401

Missing or invalid API key

Media type application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error rate_limit_error api_error

code

required

string

message

required

string

param

string

nullable

doc_url

string

nullable

Example

{
  "error": {
    "type": "invalid_request_error"
  }
}