Retrieve a reservation

GET

/v1/reservations/{id}

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

• Production

Authorizations

• api_key

Parameters

Path Parameters

id

required

string

Reservation public id (resv_…)

Query Parameters

expand

string

Responses

200

Reservation found

Media type application/json

object

object

required

string

Allowed values: reservation

id

required

string

status

required

string

Allowed values: pending confirmed partially_seated seated late completed cancelled no_show

source

required

string

Allowed values: manual widget phone walk_in import

booking_channel

required

string

Allowed values: back_office website_widget phone walk_in google_reserve

party_size

required

integer

actual_party_size

integer

nullable

service_date

required

string format: date

starts_at

required

string format: date-time

ends_at

string format: date-time

nullable

guest_notes

string

nullable

internal_notes

string

nullable

guest

Any of:

string

string

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

tables

required

Array<object>

object

object

required

string

Allowed values: table

id

required

string

name

required

string

min_capacity

required

integer

nullable

max_capacity

required

integer

nullable

section

required

object

object

required

string

Allowed values: section

id

required

string

name

required

string

area_type

required

string

Allowed values: indoor outdoor terrace bar lounge private_room patio rooftop

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "object": "reservation",
  "status": "pending",
  "source": "manual",
  "booking_channel": "back_office",
  "guest": {
    "object": "guest",
    "language": "fr",
    "source": "manual"
  },
  "tables": [
    {
      "object": "table",
      "section": {
        "object": "section",
        "area_type": "indoor"
      }
    }
  ]
}

Headers

Service-Version

string

Dated API version applied to this response

404

No such reservation

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"
  }
}