Table Groups

Server

Download schema

Table grouping and floor plans

List table groups

GET

https://common-api.karma.life

/api/v1/table-groups

List table groups with optional filtering and sorting

Permissions: 🔵 table_groups.read

List table groups › query Parameters

locationId

number

Filter by location ID

search

string

Search by name or description

sort

string

Sort field (name, created_at)

Default: name

order

string · enum

Sort order

Enum values:

asc

desc

Default: asc

page

number · min: 1

Page number

Default: 1

limit

number · min: 1 · max: 100

Items per page

Default: 20

List table groups › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Create table group

POST

https://common-api.karma.life

/api/v1/table-groups

Create a new table group

Permissions: 🟢 table_groups.create

Create table group › Request Body

locationId

number · required

Location ID

name

string · minLength: 1 · required

Group name

description

string

Group description

Create table group › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Get table group

GET

https://common-api.karma.life

/api/v1/table-groups/{id}

Get a single table group by ID with table UUIDs

Permissions: 🔵 table_groups.read

Get table group › path Parameters

id

string · pattern: ^[0-9]+$ · required

Table group ID

Get table group › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Update table group

PUT

https://common-api.karma.life

/api/v1/table-groups/{id}

Update an existing table group

Permissions: 🟠 table_groups.update

Update table group › path Parameters

id

string · pattern: ^[0-9]+$ · required

Table group ID

Update table group › Request Body

name

string · minLength: 1

description

string | null

Update table group › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Delete table group

DELETE

https://common-api.karma.life

/api/v1/table-groups/{id}

Delete a table group

Permissions: 🔴 table_groups.delete

Delete table group › path Parameters

id

string · pattern: ^[0-9]+$ · required

Table group ID

Delete table group › Responses

Table group successfully deleted

status

string · enum

Enum values:

success

object

Webhook: Table group created

POST

https://common-api.karma.life

/webhook/table-groups.created

Fired when a new table group is created. The full TableGroup 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: Table group created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

table-groups.created

resource

string · enum · required

Enum values:

table-groups

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: Table group created › Responses

200

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

No data returned

POST/webhook/table-groups.created

curl --request POST \
  --url https://common-api.karma.life/webhook/table-groups.created \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "table-groups.created",
  "resource": "table-groups",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": 0,
    "name": "name",
    "description": "description",
    "locationId": 0,
    "tableIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "table-groups.created",
  "resource": "table-groups",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": 0,
    "name": "name",
    "description": "description",
    "locationId": 0,
    "tableIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Table group updated

POST

https://common-api.karma.life

/webhook/table-groups.updated

Only the modified fields appear in changes.

Webhook: Table group updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

table-groups.updated

resource

string · enum · required

Enum values:

table-groups

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: Table group updated › Responses

200

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

No data returned

Webhook: Table group deleted

POST

https://common-api.karma.life

/webhook/table-groups.deleted

Soft delete.

Webhook: Table group deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

table-groups.deleted

resource

string · enum · required

Enum values:

table-groups

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: Table group deleted › Responses

200

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

No data returned

POST/webhook/table-groups.deleted

curl --request POST \
  --url https://common-api.karma.life/webhook/table-groups.deleted \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "table-groups.deleted",
  "resource": "table-groups",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "deletedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "table-groups.deleted",
  "resource": "table-groups",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "deletedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Statistics Tables

Karma Common API

Table Groups

Server

Download schema

Table grouping and floor plans

List table groups

GET

https://common-api.karma.life

/api/v1/table-groups

List table groups with optional filtering and sorting

Permissions: 🔵 table_groups.read

List table groups › query Parameters

locationId

number

Filter by location ID

search

string

Search by name or description

sort

string

Sort field (name, created_at)

Default: name

order

string · enum

Sort order

Enum values:

asc

desc

Default: asc

page

number · min: 1

Page number

Default: 1

limit

number · min: 1 · max: 100

Items per page

Default: 20

List table groups › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Create table group

POST

https://common-api.karma.life

/api/v1/table-groups

Create a new table group

Permissions: 🟢 table_groups.create

Create table group › Request Body

locationId

number · required

Location ID

name

string · minLength: 1 · required

Group name

description

string

Group description

Create table group › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Get table group

GET

https://common-api.karma.life

/api/v1/table-groups/{id}

Get a single table group by ID with table UUIDs

Permissions: 🔵 table_groups.read

Get table group › path Parameters

id

string · pattern: ^[0-9]+$ · required

Table group ID

Get table group › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Update table group

PUT

https://common-api.karma.life

/api/v1/table-groups/{id}

Update an existing table group

Permissions: 🟠 table_groups.update

Update table group › path Parameters

id

string · pattern: ^[0-9]+$ · required

Table group ID

Update table group › Request Body

name

string · minLength: 1

description

string | null

Update table group › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Delete table group

DELETE

https://common-api.karma.life

/api/v1/table-groups/{id}

Delete a table group

Permissions: 🔴 table_groups.delete

Delete table group › path Parameters

id

string · pattern: ^[0-9]+$ · required

Table group ID

Delete table group › Responses

Table group successfully deleted

status

string · enum

Enum values:

success

object

Webhook: Table group created

POST

https://common-api.karma.life

/webhook/table-groups.created

Fired when a new table group is created. The full TableGroup is spread into data.

Webhook: Table group created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

table-groups.created

resource

string · enum · required

Enum values:

table-groups

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: Table group created › Responses

200

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

No data returned

POST/webhook/table-groups.created

curl --request POST \
  --url https://common-api.karma.life/webhook/table-groups.created \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "table-groups.created",
  "resource": "table-groups",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": 0,
    "name": "name",
    "description": "description",
    "locationId": 0,
    "tableIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "table-groups.created",
  "resource": "table-groups",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": 0,
    "name": "name",
    "description": "description",
    "locationId": 0,
    "tableIds": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Table group updated

POST

https://common-api.karma.life

/webhook/table-groups.updated

Only the modified fields appear in changes.

Webhook: Table group updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

table-groups.updated

resource

string · enum · required

Enum values:

table-groups

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: Table group updated › Responses

200

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

No data returned

Webhook: Table group deleted

POST

https://common-api.karma.life

/webhook/table-groups.deleted

Soft delete.

Webhook: Table group deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

table-groups.deleted

resource

string · enum · required

Enum values:

table-groups

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: Table group deleted › Responses

200

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

No data returned

POST/webhook/table-groups.deleted

curl --request POST \
  --url https://common-api.karma.life/webhook/table-groups.deleted \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_01HZK3...",
  "event": "table-groups.deleted",
  "resource": "table-groups",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "deletedAt": "2024-08-25T15:00:00Z"
  }
}
'

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "table-groups.deleted",
  "resource": "table-groups",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "deletedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Statistics Tables