Bookings - Waitlist

Server

Download schema

Booking waitlist management

List waitlist

GET

https://common-api.karma.life

/api/v1/booking-waitlist

List waitlist entries

Permissions: 🔵 booking_waitlist.read

List waitlist › query Parameters

locationId

number

Filter by location ID

status

string · enum

Waitlist entry status

Enum values:

waiting

notified

converted

expired

removed

requestedDate

string · date

Filter by requested date

page

number · min: 1

Page number

Default: 1

limit

number · min: 1 · max: 100

Items per page

Default: 50

List waitlist › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Add to waitlist

POST

https://common-api.karma.life

/api/v1/booking-waitlist

Add a guest to the waitlist

Permissions: ⚪ booking_waitlist.manage

Add to waitlist › Request Body

locationId

number · required

Location ID

userId

number · required

User ID

requestedDate

string · date · required

Requested date

partySize

number · min: 1 · required

Number of guests

preferredStartTime

string

Preferred start time

preferredEndTime

string

Preferred end time

Add to waitlist › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Remove from waitlist

DELETE

https://common-api.karma.life

/api/v1/booking-waitlist/{id}

Remove a guest from the waitlist

Permissions: ⚪ booking_waitlist.manage

Remove from waitlist › path Parameters

id

string · uuid · required

Waitlist entry ID

Remove from waitlist › Responses

Default Response

status

string · enum

Enum values:

success

object

Convert waitlist to booking

POST

https://common-api.karma.life

/api/v1/booking-waitlist/{id}/convert

Convert a waitlist entry to a booking

Permissions: ⚪ booking_waitlist.manage

Convert waitlist to booking › path Parameters

id

string · uuid · required

Waitlist entry ID

Convert waitlist to booking › Request Body

startTime

string · required

Start time

endTime

string · required

End time

tableId

string · uuid

Table to assign

Convert waitlist to booking › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Notify waitlist

POST

https://common-api.karma.life

/api/v1/booking-waitlist/{id}/notify

Notify a waitlist entry of available slot

Permissions: ⚪ booking_waitlist.manage

Notify waitlist › path Parameters

id

string · uuid · required

Waitlist entry ID

Notify waitlist › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Webhook: Waitlist entry joined

POST

https://common-api.karma.life

/webhook/waitlist.joined

Fired when a guest joins the waitlist. The full waitlist entry is spread into data.

This is an outbound webhook event. Karma POSTs this payload to the URL you registered via POST /api/v1/webhooks/subscriptions. Your endpoint should respond 2xx within 30 seconds to acknowledge delivery.

Webhook: Waitlist entry joined › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

waitlist.joined

resource

string · enum · required

Enum values:

waitlist

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Waitlist entry joined › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/waitlist.joined

curl --request POST \
  --url https://common-api.karma.life/webhook/waitlist.joined \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "waitlist.joined",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "userId": 0,
    "requestedDate": "2024-08-25",
    "preferredStartTime": "preferredStartTime",
    "preferredEndTime": "preferredEndTime",
    "partySize": 0,
    "status": "waiting",
    "convertedBookingId": "00000000-0000-0000-0000-000000000000",
    "expiresAt": "2024-08-25T15:00:00Z",
    "notifiedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "waitlist.joined",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "userId": 0,
    "requestedDate": "2024-08-25",
    "preferredStartTime": "preferredStartTime",
    "preferredEndTime": "preferredEndTime",
    "partySize": 0,
    "status": "waiting",
    "convertedBookingId": "00000000-0000-0000-0000-000000000000",
    "expiresAt": "2024-08-25T15:00:00Z",
    "notifiedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Waitlist entry notified

POST

https://common-api.karma.life

/webhook/waitlist.notified

Fired when a waitlist entry is notified that a table is available.

Webhook: Waitlist entry notified › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

waitlist.notified

resource

string · enum · required

Enum values:

waitlist

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Waitlist entry notified › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/waitlist.notified

curl --request POST \
  --url https://common-api.karma.life/webhook/waitlist.notified \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "waitlist.notified",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "userId": 0,
    "requestedDate": "2024-08-25",
    "preferredStartTime": "preferredStartTime",
    "preferredEndTime": "preferredEndTime",
    "partySize": 0,
    "status": "waiting",
    "convertedBookingId": "00000000-0000-0000-0000-000000000000",
    "expiresAt": "2024-08-25T15:00:00Z",
    "notifiedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "waitlist.notified",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "userId": 0,
    "requestedDate": "2024-08-25",
    "preferredStartTime": "preferredStartTime",
    "preferredEndTime": "preferredEndTime",
    "partySize": 0,
    "status": "waiting",
    "convertedBookingId": "00000000-0000-0000-0000-000000000000",
    "expiresAt": "2024-08-25T15:00:00Z",
    "notifiedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Waitlist entry converted to booking

POST

https://common-api.karma.life

/webhook/waitlist.converted

Fired when a waitlist entry is converted into a booking. Links the entry to the new booking ID.

Webhook: Waitlist entry converted to booking › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

waitlist.converted

resource

string · enum · required

Enum values:

waitlist

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Waitlist entry converted to booking › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/waitlist.converted

curl --request POST \
  --url https://common-api.karma.life/webhook/waitlist.converted \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "waitlist.converted",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "convertedAt": "2024-08-25T15:00:00Z",
    "bookingId": "00000000-0000-0000-0000-000000000000"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "waitlist.converted",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "convertedAt": "2024-08-25T15:00:00Z",
    "bookingId": "00000000-0000-0000-0000-000000000000"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Waitlist entry removed

POST

https://common-api.karma.life

/webhook/waitlist.removed

Fired when a waitlist entry is removed.

Webhook: Waitlist entry removed › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

waitlist.removed

resource

string · enum · required

Enum values:

waitlist

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Waitlist entry removed › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Bookings - Users Capacity Settings

Karma Common API

Bookings - Waitlist

Server

Download schema

Booking waitlist management

List waitlist

GET

https://common-api.karma.life

/api/v1/booking-waitlist

List waitlist entries

Permissions: 🔵 booking_waitlist.read

List waitlist › query Parameters

locationId

number

Filter by location ID

status

string · enum

Waitlist entry status

Enum values:

waiting

notified

converted

expired

removed

requestedDate

string · date

Filter by requested date

page

number · min: 1

Page number

Default: 1

limit

number · min: 1 · max: 100

Items per page

Default: 50

List waitlist › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Add to waitlist

POST

https://common-api.karma.life

/api/v1/booking-waitlist

Add a guest to the waitlist

Permissions: ⚪ booking_waitlist.manage

Add to waitlist › Request Body

locationId

number · required

Location ID

userId

number · required

User ID

requestedDate

string · date · required

Requested date

partySize

number · min: 1 · required

Number of guests

preferredStartTime

string

Preferred start time

preferredEndTime

string

Preferred end time

Add to waitlist › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Remove from waitlist

DELETE

https://common-api.karma.life

/api/v1/booking-waitlist/{id}

Remove a guest from the waitlist

Permissions: ⚪ booking_waitlist.manage

Remove from waitlist › path Parameters

id

string · uuid · required

Waitlist entry ID

Remove from waitlist › Responses

Default Response

status

string · enum

Enum values:

success

object

Convert waitlist to booking

POST

https://common-api.karma.life

/api/v1/booking-waitlist/{id}/convert

Convert a waitlist entry to a booking

Permissions: ⚪ booking_waitlist.manage

Convert waitlist to booking › path Parameters

id

string · uuid · required

Waitlist entry ID

Convert waitlist to booking › Request Body

startTime

string · required

Start time

endTime

string · required

End time

tableId

string · uuid

Table to assign

Convert waitlist to booking › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Notify waitlist

POST

https://common-api.karma.life

/api/v1/booking-waitlist/{id}/notify

Notify a waitlist entry of available slot

Permissions: ⚪ booking_waitlist.manage

Notify waitlist › path Parameters

id

string · uuid · required

Waitlist entry ID

Notify waitlist › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Webhook: Waitlist entry joined

POST

https://common-api.karma.life

/webhook/waitlist.joined

Fired when a guest joins the waitlist. The full waitlist entry is spread into data.

Webhook: Waitlist entry joined › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

waitlist.joined

resource

string · enum · required

Enum values:

waitlist

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Waitlist entry joined › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/waitlist.joined

curl --request POST \
  --url https://common-api.karma.life/webhook/waitlist.joined \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "waitlist.joined",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "userId": 0,
    "requestedDate": "2024-08-25",
    "preferredStartTime": "preferredStartTime",
    "preferredEndTime": "preferredEndTime",
    "partySize": 0,
    "status": "waiting",
    "convertedBookingId": "00000000-0000-0000-0000-000000000000",
    "expiresAt": "2024-08-25T15:00:00Z",
    "notifiedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "waitlist.joined",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "userId": 0,
    "requestedDate": "2024-08-25",
    "preferredStartTime": "preferredStartTime",
    "preferredEndTime": "preferredEndTime",
    "partySize": 0,
    "status": "waiting",
    "convertedBookingId": "00000000-0000-0000-0000-000000000000",
    "expiresAt": "2024-08-25T15:00:00Z",
    "notifiedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Waitlist entry notified

POST

https://common-api.karma.life

/webhook/waitlist.notified

Fired when a waitlist entry is notified that a table is available.

Webhook: Waitlist entry notified › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

waitlist.notified

resource

string · enum · required

Enum values:

waitlist

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object · required

Webhook: Waitlist entry notified › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/waitlist.notified

curl --request POST \
  --url https://common-api.karma.life/webhook/waitlist.notified \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "waitlist.notified",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "userId": 0,
    "requestedDate": "2024-08-25",
    "preferredStartTime": "preferredStartTime",
    "preferredEndTime": "preferredEndTime",
    "partySize": 0,
    "status": "waiting",
    "convertedBookingId": "00000000-0000-0000-0000-000000000000",
    "expiresAt": "2024-08-25T15:00:00Z",
    "notifiedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "waitlist.notified",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "locationId": 0,
    "userId": 0,
    "requestedDate": "2024-08-25",
    "preferredStartTime": "preferredStartTime",
    "preferredEndTime": "preferredEndTime",
    "partySize": 0,
    "status": "waiting",
    "convertedBookingId": "00000000-0000-0000-0000-000000000000",
    "expiresAt": "2024-08-25T15:00:00Z",
    "notifiedAt": "2024-08-25T15:00:00Z",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Waitlist entry converted to booking

POST

https://common-api.karma.life

/webhook/waitlist.converted

Fired when a waitlist entry is converted into a booking. Links the entry to the new booking ID.

Webhook: Waitlist entry converted to booking › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

waitlist.converted

resource

string · enum · required

Enum values:

waitlist

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Waitlist entry converted to booking › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

POST/webhook/waitlist.converted

curl --request POST \
  --url https://common-api.karma.life/webhook/waitlist.converted \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "waitlist.converted",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "convertedAt": "2024-08-25T15:00:00Z",
    "bookingId": "00000000-0000-0000-0000-000000000000"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "waitlist.converted",
  "resource": "waitlist",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "convertedAt": "2024-08-25T15:00:00Z",
    "bookingId": "00000000-0000-0000-0000-000000000000"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Waitlist entry removed

POST

https://common-api.karma.life

/webhook/waitlist.removed

Fired when a waitlist entry is removed.

Webhook: Waitlist entry removed › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

waitlist.removed

resource

string · enum · required

Enum values:

waitlist

resourceId

string · required

String ID of the affected resource

timestamp

string · date-time · required

ISO 8601 timestamp when the event was emitted

apiVersion

string · enum · required

Enum values:

object

Webhook: Waitlist entry removed › Responses

200

Acknowledged. Karma considers any 2xx response a successful delivery; non-2xx triggers retry with exponential backoff.

No data returned

Bookings - Users Capacity Settings