You are viewing a non-production environment — the API surface may differ from production.
Developers
Booking API

Tables

Restaurant table management

List staff for a location

GET
/api/v1/locations/{locationId}/staff

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

locationId*string

Location ID

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/locations/string/staff"
{  "status": "success",  "data": {    "staff": [      {        "id": 0,        "name": null,        "color": null      }    ]  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

Update a staff member's color

PUT
/api/v1/retailer-users/{retailerUserId}/color

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

retailerUserId*string

Retailer user ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

color*|

Hex color (#RRGGBB) or null to clear.

Match^#[0-9a-fA-F]{6}$

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/retailer-users/string/color" \  -H "Content-Type: application/json" \  -d '{    "color": "string"  }'
{  "status": "success",  "data": {    "id": 0,    "name": null,    "color": null  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

List tables

GET
/api/v1/tables

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Query Parameters

locationId?number

Filter by location ID

status?string

Filter by status

Value in

  • "live"
  • "paused"
  • "deleted"
tableGroupId?number

Filter by table group ID

search?string

Search by name or description

page?number

Page number

Range1 <= value
Default1
limit?number

Items per page

Range1 <= value <= 999
Default20

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/tables"
{  "status": "success",  "data": {    "tables": [      {        "customFields": [          {            "fieldId": "string",            "key": "string",            "label": "string",            "group": "string",            "type": "string",            "displayValue": "string",            "value": null,            "version": 0,            "status": "string"          }        ],        "metadata": {          "customFields": {}        },        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "description": "string",        "contextParams": {},        "locationId": 0,        "storefrontUrl": "http://example.com",        "tableGroupId": 0,        "costCenterId": 0,        "status": "live",        "qrCodeImageUrl": "http://example.com",        "activeTabs": [          {            "customFields": [              {                "fieldId": "string",                "key": "string",                "label": "string",                "group": "string",                "type": "string",                "displayValue": "string",                "value": null,                "version": 0,                "status": "string"              }            ],            "metadata": {              "customFields": {}            },            "id": "string",            "state": "string",            "orderTotal": 0,            "paidTotal": 0,            "tipsTotal": 0,            "selectedPaymentFlow": "string",            "coursingOrder": 0,            "memberCount": 0,            "totalAmountCents": 0,            "paidAmountCents": 0,            "remainingBalanceCents": 0,            "paymentMode": "ITEM",            "storefrontQrCodeId": "cc98aae0-77ff-4b53-9c46-3ce3e07559af",            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z",            "extras": [              {}            ],            "kitchenDispatches": [              {                "customFields": [                  {                    "fieldId": "string",                    "key": "string",                    "label": "string",                    "group": "string",                    "type": "string",                    "displayValue": "string",                    "value": null,                    "version": 0,                    "status": "string"                  }                ],                "metadata": {                  "customFields": {}                },                "id": "string",                "createdAt": "2019-08-24T14:15:22Z",                "dailyOrderNumber": 0,                "state": "string",                "tabUUID": "string",                "tabType": "string",                "tableName": "string",                "tabState": "string",                "source": "string",                "message": "string",                "comments": [                  {                    "comment": "string",                    "createdAt": "2019-08-24T14:15:22Z",                    "tabMemberUUID": "string",                    "uuid": "string"                  }                ],                "kitchenDispatchItems": [                  {                    "id": "string",                    "itemId": 0,                    "saleItemId": 0,                    "price": 0,                    "basePrice": 0,                    "quantityCents": 0,                    "coursingOrder": 0,                    "kitchenSortOrder": 0,                    "isNonSurplus": true,                    "settlementState": "string",                    "itemState": "string",                    "zeroTicket": true,                    "voidedQuantityCents": 0,                    "title": "string",                    "tabMember": {                      "uuid": "string",                      "name": "string",                      "email": "string"                    },                    "comments": [                      {                        "comment": "string",                        "createdAt": "2019-08-24T14:15:22Z",                        "tabMemberUUID": "string",                        "uuid": "string"                      }                    ],                    "variants": [                      {                        "id": 0,                        "name": "string",                        "price": 0,                        "quantityCents": 0,                        "priceCents": 0                      }                    ]                  }                ]              }            ],            "notes": [              {                "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",                "entityType": "tab",                "entityId": "string",                "note": "string",                "locationId": 0,                "sortOrder": 0,                "createdByRetailerUserId": 0,                "createdByName": "string",                "updatedByRetailerUserId": 0,                "updatedByName": "string",                "createdAt": "2019-08-24T14:15:22Z",                "updatedAt": "2019-08-24T14:15:22Z"              }            ],            "showNotesOnMap": true,            "tableDisplayName": "string",            "preCheckPrintedAt": "2019-08-24T14:15:22Z"          }        ],        "totalOrderAmountOnActiveTables": 0,        "totalPaidAmountOnActiveTables": 0,        "isBookable": true,        "minCapacity": null,        "maxCapacity": null,        "seatingDurationMinutes": null,        "serviceFeeOverride": {          "enabled": true,          "title": "string",          "description": "string",          "type": "fixed",          "fixedCents": 0,          "percentageBps": 0,          "vatId": 0        },        "newTabPerGuest": true,        "requireGuestCount": true,        "assignedRetailerUser": {          "id": 0,          "name": null,          "color": null        },        "externalId": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": null      }    ],    "pagination": {      "page": 1,      "limit": 1,      "total": 0,      "totalPages": 0    }  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

Create table

POST
/api/v1/tables

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Table name/number

Length1 <= length
description?string

Table description

locationId*number

Location ID

tableGroupId?number

Table group ID

costCenterId?|

Cost center ID

contextParams?

Custom context parameters

customFields?array<|>

Optional custom field operations, saved atomically with this record. Omitted values are unchanged; null clears. Use fieldId or a stable key. expectedVersion is optional; supply it to reject conflicting edits.

Itemsitems <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/tables" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "locationId": 0  }'
{  "status": "success",  "data": {    "customFields": [      {        "fieldId": "string",        "key": "string",        "label": "string",        "group": "string",        "type": "string",        "displayValue": "string",        "value": null,        "version": 0,        "status": "string"      }    ],    "metadata": {      "customFields": {}    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "contextParams": {},    "locationId": 0,    "storefrontUrl": "http://example.com",    "tableGroupId": 0,    "costCenterId": 0,    "status": "live",    "qrCodeImageUrl": "http://example.com",    "activeTabs": [      {        "customFields": [          {            "fieldId": "string",            "key": "string",            "label": "string",            "group": "string",            "type": "string",            "displayValue": "string",            "value": null,            "version": 0,            "status": "string"          }        ],        "metadata": {          "customFields": {}        },        "id": "string",        "state": "string",        "orderTotal": 0,        "paidTotal": 0,        "tipsTotal": 0,        "selectedPaymentFlow": "string",        "coursingOrder": 0,        "memberCount": 0,        "totalAmountCents": 0,        "paidAmountCents": 0,        "remainingBalanceCents": 0,        "paymentMode": "ITEM",        "storefrontQrCodeId": "cc98aae0-77ff-4b53-9c46-3ce3e07559af",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "extras": [          {}        ],        "kitchenDispatches": [          {            "customFields": [              {                "fieldId": "string",                "key": "string",                "label": "string",                "group": "string",                "type": "string",                "displayValue": "string",                "value": null,                "version": 0,                "status": "string"              }            ],            "metadata": {              "customFields": {}            },            "id": "string",            "createdAt": "2019-08-24T14:15:22Z",            "dailyOrderNumber": 0,            "state": "string",            "tabUUID": "string",            "tabType": "string",            "tableName": "string",            "tabState": "string",            "source": "string",            "message": "string",            "comments": [              {                "comment": "string",                "createdAt": "2019-08-24T14:15:22Z",                "tabMemberUUID": "string",                "uuid": "string"              }            ],            "kitchenDispatchItems": [              {                "id": "string",                "itemId": 0,                "saleItemId": 0,                "price": 0,                "basePrice": 0,                "quantityCents": 0,                "coursingOrder": 0,                "kitchenSortOrder": 0,                "isNonSurplus": true,                "settlementState": "string",                "itemState": "string",                "zeroTicket": true,                "voidedQuantityCents": 0,                "title": "string",                "tabMember": {                  "uuid": "string",                  "name": "string",                  "email": "string"                },                "comments": [                  {                    "comment": "string",                    "createdAt": "2019-08-24T14:15:22Z",                    "tabMemberUUID": "string",                    "uuid": "string"                  }                ],                "variants": [                  {                    "id": 0,                    "name": "string",                    "price": 0,                    "quantityCents": 0,                    "priceCents": 0                  }                ]              }            ]          }        ],        "notes": [          {            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",            "entityType": "tab",            "entityId": "string",            "note": "string",            "locationId": 0,            "sortOrder": 0,            "createdByRetailerUserId": 0,            "createdByName": "string",            "updatedByRetailerUserId": 0,            "updatedByName": "string",            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z"          }        ],        "showNotesOnMap": true,        "tableDisplayName": "string",        "preCheckPrintedAt": "2019-08-24T14:15:22Z"      }    ],    "totalOrderAmountOnActiveTables": 0,    "totalPaidAmountOnActiveTables": 0,    "isBookable": true,    "minCapacity": null,    "maxCapacity": null,    "seatingDurationMinutes": null,    "serviceFeeOverride": {      "enabled": true,      "title": "string",      "description": "string",      "type": "fixed",      "fixedCents": 0,      "percentageBps": 0,      "vatId": 0    },    "newTabPerGuest": true,    "requireGuestCount": true,    "assignedRetailerUser": {      "id": 0,      "name": null,      "color": null    },    "externalId": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": null  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

Get table details

GET
/api/v1/tables/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

id*string

Table UUID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/tables/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "status": "success",  "data": {    "customFields": [      {        "fieldId": "string",        "key": "string",        "label": "string",        "group": "string",        "type": "string",        "displayValue": "string",        "value": null,        "version": 0,        "status": "string"      }    ],    "metadata": {      "customFields": {}    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "contextParams": {},    "locationId": 0,    "storefrontUrl": "http://example.com",    "tableGroupId": 0,    "costCenterId": 0,    "status": "live",    "qrCodeImageUrl": "http://example.com",    "activeTabs": [      {        "customFields": [          {            "fieldId": "string",            "key": "string",            "label": "string",            "group": "string",            "type": "string",            "displayValue": "string",            "value": null,            "version": 0,            "status": "string"          }        ],        "metadata": {          "customFields": {}        },        "id": "string",        "state": "string",        "orderTotal": 0,        "paidTotal": 0,        "tipsTotal": 0,        "selectedPaymentFlow": "string",        "coursingOrder": 0,        "memberCount": 0,        "totalAmountCents": 0,        "paidAmountCents": 0,        "remainingBalanceCents": 0,        "paymentMode": "ITEM",        "storefrontQrCodeId": "cc98aae0-77ff-4b53-9c46-3ce3e07559af",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "extras": [          {}        ],        "kitchenDispatches": [          {            "customFields": [              {                "fieldId": "string",                "key": "string",                "label": "string",                "group": "string",                "type": "string",                "displayValue": "string",                "value": null,                "version": 0,                "status": "string"              }            ],            "metadata": {              "customFields": {}            },            "id": "string",            "createdAt": "2019-08-24T14:15:22Z",            "dailyOrderNumber": 0,            "state": "string",            "tabUUID": "string",            "tabType": "string",            "tableName": "string",            "tabState": "string",            "source": "string",            "message": "string",            "comments": [              {                "comment": "string",                "createdAt": "2019-08-24T14:15:22Z",                "tabMemberUUID": "string",                "uuid": "string"              }            ],            "kitchenDispatchItems": [              {                "id": "string",                "itemId": 0,                "saleItemId": 0,                "price": 0,                "basePrice": 0,                "quantityCents": 0,                "coursingOrder": 0,                "kitchenSortOrder": 0,                "isNonSurplus": true,                "settlementState": "string",                "itemState": "string",                "zeroTicket": true,                "voidedQuantityCents": 0,                "title": "string",                "tabMember": {                  "uuid": "string",                  "name": "string",                  "email": "string"                },                "comments": [                  {                    "comment": "string",                    "createdAt": "2019-08-24T14:15:22Z",                    "tabMemberUUID": "string",                    "uuid": "string"                  }                ],                "variants": [                  {                    "id": 0,                    "name": "string",                    "price": 0,                    "quantityCents": 0,                    "priceCents": 0                  }                ]              }            ]          }        ],        "notes": [          {            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",            "entityType": "tab",            "entityId": "string",            "note": "string",            "locationId": 0,            "sortOrder": 0,            "createdByRetailerUserId": 0,            "createdByName": "string",            "updatedByRetailerUserId": 0,            "updatedByName": "string",            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z"          }        ],        "showNotesOnMap": true,        "tableDisplayName": "string",        "preCheckPrintedAt": "2019-08-24T14:15:22Z"      }    ],    "totalOrderAmountOnActiveTables": 0,    "totalPaidAmountOnActiveTables": 0,    "isBookable": true,    "minCapacity": null,    "maxCapacity": null,    "seatingDurationMinutes": null,    "serviceFeeOverride": {      "enabled": true,      "title": "string",      "description": "string",      "type": "fixed",      "fixedCents": 0,      "percentageBps": 0,      "vatId": 0    },    "newTabPerGuest": true,    "requireGuestCount": true,    "assignedRetailerUser": {      "id": 0,      "name": null,      "color": null    },    "externalId": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": null  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

Delete table

DELETE
/api/v1/tables/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

id*string

Table UUID

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/tables/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "status": "success",  "data": {    "deleted": true  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

Update table

PUT
/api/v1/tables/{id}

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

id*string

Table UUID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string
Length1 <= length
description?string|null
tableGroupId?number|null
costCenterId?|

Cost center ID

status?string

Value in

  • "live"
  • "paused"
  • "deleted"
contextParams?
isBookable?boolean
minCapacity?number|null
maxCapacity?number|null
seatingDurationMinutes?number|null
serviceFeeOverride?|null
newTabPerGuest?boolean

Force a new tab on every scan (theme parks, festivals, shared kiosks).

requireGuestCount?boolean

Prompt POS staff for guest count when seating an empty table.

assignedRetailerUserId?|

Server (retailer_user) to assign to this table. Pass null to clear. Must reference an active retailer_user with access to this location.

externalId?|

External POS table identifier. When set, overrides the table name as the POS table reference (e.g. Trivec table ID).

customFields?array<|>

Optional custom field operations, saved atomically with this record. Omitted values are unchanged; null clears. Use fieldId or a stable key. expectedVersion is optional; supply it to reject conflicting edits.

Itemsitems <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/tables/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "status": "success",  "data": {    "customFields": [      {        "fieldId": "string",        "key": "string",        "label": "string",        "group": "string",        "type": "string",        "displayValue": "string",        "value": null,        "version": 0,        "status": "string"      }    ],    "metadata": {      "customFields": {}    },    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "contextParams": {},    "locationId": 0,    "storefrontUrl": "http://example.com",    "tableGroupId": 0,    "costCenterId": 0,    "status": "live",    "qrCodeImageUrl": "http://example.com",    "activeTabs": [      {        "customFields": [          {            "fieldId": "string",            "key": "string",            "label": "string",            "group": "string",            "type": "string",            "displayValue": "string",            "value": null,            "version": 0,            "status": "string"          }        ],        "metadata": {          "customFields": {}        },        "id": "string",        "state": "string",        "orderTotal": 0,        "paidTotal": 0,        "tipsTotal": 0,        "selectedPaymentFlow": "string",        "coursingOrder": 0,        "memberCount": 0,        "totalAmountCents": 0,        "paidAmountCents": 0,        "remainingBalanceCents": 0,        "paymentMode": "ITEM",        "storefrontQrCodeId": "cc98aae0-77ff-4b53-9c46-3ce3e07559af",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "extras": [          {}        ],        "kitchenDispatches": [          {            "customFields": [              {                "fieldId": "string",                "key": "string",                "label": "string",                "group": "string",                "type": "string",                "displayValue": "string",                "value": null,                "version": 0,                "status": "string"              }            ],            "metadata": {              "customFields": {}            },            "id": "string",            "createdAt": "2019-08-24T14:15:22Z",            "dailyOrderNumber": 0,            "state": "string",            "tabUUID": "string",            "tabType": "string",            "tableName": "string",            "tabState": "string",            "source": "string",            "message": "string",            "comments": [              {                "comment": "string",                "createdAt": "2019-08-24T14:15:22Z",                "tabMemberUUID": "string",                "uuid": "string"              }            ],            "kitchenDispatchItems": [              {                "id": "string",                "itemId": 0,                "saleItemId": 0,                "price": 0,                "basePrice": 0,                "quantityCents": 0,                "coursingOrder": 0,                "kitchenSortOrder": 0,                "isNonSurplus": true,                "settlementState": "string",                "itemState": "string",                "zeroTicket": true,                "voidedQuantityCents": 0,                "title": "string",                "tabMember": {                  "uuid": "string",                  "name": "string",                  "email": "string"                },                "comments": [                  {                    "comment": "string",                    "createdAt": "2019-08-24T14:15:22Z",                    "tabMemberUUID": "string",                    "uuid": "string"                  }                ],                "variants": [                  {                    "id": 0,                    "name": "string",                    "price": 0,                    "quantityCents": 0,                    "priceCents": 0                  }                ]              }            ]          }        ],        "notes": [          {            "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",            "entityType": "tab",            "entityId": "string",            "note": "string",            "locationId": 0,            "sortOrder": 0,            "createdByRetailerUserId": 0,            "createdByName": "string",            "updatedByRetailerUserId": 0,            "updatedByName": "string",            "createdAt": "2019-08-24T14:15:22Z",            "updatedAt": "2019-08-24T14:15:22Z"          }        ],        "showNotesOnMap": true,        "tableDisplayName": "string",        "preCheckPrintedAt": "2019-08-24T14:15:22Z"      }    ],    "totalOrderAmountOnActiveTables": 0,    "totalPaidAmountOnActiveTables": 0,    "isBookable": true,    "minCapacity": null,    "maxCapacity": null,    "seatingDurationMinutes": null,    "serviceFeeOverride": {      "enabled": true,      "title": "string",      "description": "string",      "type": "fixed",      "fixedCents": 0,      "percentageBps": 0,      "vatId": 0    },    "newTabPerGuest": true,    "requireGuestCount": true,    "assignedRetailerUser": {      "id": 0,      "name": null,      "color": null    },    "externalId": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": null  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

Get table tab history

GET
/api/v1/tables/{id}/tab-history

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Path Parameters

id*string
Formatuuid

Query Parameters

page?integer
Range1 <= value
Default1
limit?integer
Range1 <= value <= 100
Default10

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/tables/497f6eca-6276-4993-bfeb-53cbbbba6f08/tab-history"
{  "status": "success",  "data": {    "tabs": [      {        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",        "locationId": 0,        "latestState": "string",        "selectedPaymentFlow": "string",        "paymentMode": "string",        "totalAmountCents": 0,        "paidAmountCents": 0,        "remainingBalanceCents": 0,        "storefrontQrCodeId": "string",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "association": {          "status": "current",          "eventType": "string",          "occurredAt": "2019-08-24T14:15:22Z",          "sourceTable": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "name": "string"          },          "destinationTable": {            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",            "name": "string"          },          "actor": {            "id": 0,            "name": "string",            "email": "string"          }        }      }    ],    "pagination": {      "page": 1,      "limit": 1,      "total": 0,      "totalPages": 0    }  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

Bulk delete tables

DELETE
/api/v1/tables/bulk

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tableIds*array<>

Table UUIDs to soft delete. Every table must belong to the same location.

Items1 <= items <= 500

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v1/tables/bulk" \  -H "Content-Type: application/json" \  -d '{    "tableIds": [      "0f15e971-bb89-4712-9d06-bc444ed39ebe"    ]  }'
{  "status": "success",  "data": {    "ids": [      "6e0346a3-e54d-40e3-9779-4ba1e707e35b"    ],    "count": 0,    "deleted": true  },  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

Bulk update tables

PUT
/api/v1/tables/bulk

Authorization

ApiKeyAuth
X-API-Key<token>

API key authentication. Format: karma_live_* or karma_dev_*

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tableIds*array<>

Array of table UUIDs to update

Items1 <= items
tableGroupId?|

Table group ID to assign (null to remove from group)

name?string

Name to set on all selected tables

Length1 <= length
description?string

Description to set on all selected tables

costCenterId?|

Cost center ID to assign (null to clear)

contextParamsToMerge?

Context parameters to merge into existing params

contextParamsToDelete?array<string>

Context parameter keys to delete

status?string

Status to set on all tables

Value in

  • "live"
  • "paused"
  • "deleted"
isBookable?boolean
minCapacity?number|null
maxCapacity?number|null
seatingDurationMinutes?number|null
serviceFeeOverride?|null
newTabPerGuest?boolean
requireGuestCount?boolean
assignedRetailerUserId?|

Server to assign to every selected table (null to clear)

externalId?|

External POS table identifier to set on all selected tables (null to clear)

customFields?array<|>

Optional custom field operations, saved atomically with this record. Omitted values are unchanged; null clears. Use fieldId or a stable key. expectedVersion is optional; supply it to reject conflicting edits.

Itemsitems <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/tables/bulk" \  -H "Content-Type: application/json" \  -d '{    "tableIds": [      "0f15e971-bb89-4712-9d06-bc444ed39ebe"    ]  }'
{  "status": "success",  "data": [    {      "customFields": [        {          "fieldId": "string",          "key": "string",          "label": "string",          "group": "string",          "type": "string",          "displayValue": "string",          "value": null,          "version": 0,          "status": "string"        }      ],      "metadata": {        "customFields": {}      },      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "description": "string",      "contextParams": {},      "locationId": 0,      "storefrontUrl": "http://example.com",      "tableGroupId": 0,      "costCenterId": 0,      "status": "live",      "qrCodeImageUrl": "http://example.com",      "activeTabs": [        {          "customFields": [            {              "fieldId": "string",              "key": "string",              "label": "string",              "group": "string",              "type": "string",              "displayValue": "string",              "value": null,              "version": 0,              "status": "string"            }          ],          "metadata": {            "customFields": {}          },          "id": "string",          "state": "string",          "orderTotal": 0,          "paidTotal": 0,          "tipsTotal": 0,          "selectedPaymentFlow": "string",          "coursingOrder": 0,          "memberCount": 0,          "totalAmountCents": 0,          "paidAmountCents": 0,          "remainingBalanceCents": 0,          "paymentMode": "ITEM",          "storefrontQrCodeId": "cc98aae0-77ff-4b53-9c46-3ce3e07559af",          "createdAt": "2019-08-24T14:15:22Z",          "updatedAt": "2019-08-24T14:15:22Z",          "extras": [            {}          ],          "kitchenDispatches": [            {              "customFields": [                {                  "fieldId": "string",                  "key": "string",                  "label": "string",                  "group": "string",                  "type": "string",                  "displayValue": "string",                  "value": null,                  "version": 0,                  "status": "string"                }              ],              "metadata": {                "customFields": {}              },              "id": "string",              "createdAt": "2019-08-24T14:15:22Z",              "dailyOrderNumber": 0,              "state": "string",              "tabUUID": "string",              "tabType": "string",              "tableName": "string",              "tabState": "string",              "source": "string",              "message": "string",              "comments": [                {                  "comment": "string",                  "createdAt": "2019-08-24T14:15:22Z",                  "tabMemberUUID": "string",                  "uuid": "string"                }              ],              "kitchenDispatchItems": [                {                  "id": "string",                  "itemId": 0,                  "saleItemId": 0,                  "price": 0,                  "basePrice": 0,                  "quantityCents": 0,                  "coursingOrder": 0,                  "kitchenSortOrder": 0,                  "isNonSurplus": true,                  "settlementState": "string",                  "itemState": "string",                  "zeroTicket": true,                  "voidedQuantityCents": 0,                  "title": "string",                  "tabMember": {                    "uuid": "string",                    "name": "string",                    "email": "string"                  },                  "comments": [                    {                      "comment": "string",                      "createdAt": "2019-08-24T14:15:22Z",                      "tabMemberUUID": "string",                      "uuid": "string"                    }                  ],                  "variants": [                    {                      "id": 0,                      "name": "string",                      "price": 0,                      "quantityCents": 0,                      "priceCents": 0                    }                  ]                }              ]            }          ],          "notes": [            {              "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",              "entityType": "tab",              "entityId": "string",              "note": "string",              "locationId": 0,              "sortOrder": 0,              "createdByRetailerUserId": 0,              "createdByName": "string",              "updatedByRetailerUserId": 0,              "updatedByName": "string",              "createdAt": "2019-08-24T14:15:22Z",              "updatedAt": "2019-08-24T14:15:22Z"            }          ],          "showNotesOnMap": true,          "tableDisplayName": "string",          "preCheckPrintedAt": "2019-08-24T14:15:22Z"        }      ],      "totalOrderAmountOnActiveTables": 0,      "totalPaidAmountOnActiveTables": 0,      "isBookable": true,      "minCapacity": null,      "maxCapacity": null,      "seatingDurationMinutes": null,      "serviceFeeOverride": {        "enabled": true,        "title": "string",        "description": "string",        "type": "fixed",        "fixedCents": 0,        "percentageBps": 0,        "vatId": 0      },      "newTabPerGuest": true,      "requireGuestCount": true,      "assignedRetailerUser": {        "id": 0,        "name": null,        "color": null      },      "externalId": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": null    }  ],  "meta": {    "requestId": "string",    "timestamp": "2019-08-24T14:15:22Z",    "executionTimeMs": 0  }}

Bookings Waitlist

Booking waitlist management

Table Groups

Table grouping and floor plans