List reservation lifecycle events

GET

/v1/reservations/{id}/events

const url = 'https://api.useservice.app/v1/reservations/example/events';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

api_key

Parameters

Path Parameters

required

string

Query Parameters

limit

integer

starting_after

string

Responses

200

Events listed

application/json

object

object

required

string

Allowed values: list

data

required

Array<object>

object

object

required

string

Allowed values: reservation_event

required

string

type

required

string

Allowed values: reservation.created reservation.confirmed reservation.declined reservation.updated reservation.pending reservation.partially_seated reservation.seated reservation.completed reservation.cancelled reservation.no_show

created_at

required

string format: date-time

data

required

object

key

additional properties

any

has_more

required

boolean

Example

{
  "object": "list",
  "data": [
    {
      "object": "reservation_event",
      "type": "reservation.created"
    }
  ]
}

Headers

Service-Version

string

Dated API version applied to this response

404

No such reservation

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