Schedules

Server

Download schema

Operating hours and special schedules

List schedules

GET

https://common-api.karma.life

/api/v1/schedules

List schedules with optional filtering

List schedules › query Parameters

locationId

number

Filter by location ID

entityType

string · enum

Filter by entity type

Enum values:

ITEM

LOCATION

MODIFIER

List schedules › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Create schedule

POST

https://common-api.karma.life

/api/v1/schedules

Create a new schedule with rules

Permissions: 🟢 schedules.create

Create schedule › Request Body

entityType

string · enum · required

Type of entity being scheduled

Enum values:

ITEM

LOCATION

MODIFIER

Create schedule › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/schedules

curl --request POST \
  --url https://common-api.karma.life/api/v1/schedules \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityType": "MENU",
  "entityId": "entityId",
  "locationId": 0,
  "name": "name",
  "description": "description",
  "isActive": true,
  "priority": 0,
  "rules": [
    {
      "ruleType": "WEEKDAY",
      "weekday": 0,
      "startTime": "startTime",
      "endTime": "endTime",
      "startDate": "2024-08-25",
      "endDate": "2024-08-25",
      "validFrom": "2024-08-25",
      "validTo": "2024-08-25",
      "isAvailable": true
    }
  ]
}
'

Example Request Body

{
  "entityType": "MENU",
  "entityId": "entityId",
  "locationId": 0,
  "name": "name",
  "description": "description",
  "isActive": true,
  "priority": 0,
  "rules": [
    {
      "ruleType": "WEEKDAY",
      "weekday": 0,
      "startTime": "startTime",
      "endTime": "endTime",
      "startDate": "2024-08-25",
      "endDate": "2024-08-25",
      "validFrom": "2024-08-25",
      "validTo": "2024-08-25",
      "isAvailable": true
    }
  ]
}

json

Example Responses

No example specified for this content type

application/json

Get schedule

GET

https://common-api.karma.life

/api/v1/schedules/{id}

Get a single schedule by ID with its rules

Get schedule › path Parameters

id

string · required

Schedule ID

Get schedule › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Update schedule

PUT

https://common-api.karma.life

/api/v1/schedules/{id}

Update an existing schedule

Permissions: 🟠 schedules.update

Update schedule › path Parameters

id

string · required

Schedule ID

Update schedule › Request Body

name

string

description

string | null

isActive

boolean

priority

number

Update schedule › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Delete schedule

DELETE

https://common-api.karma.life

/api/v1/schedules/{id}

Delete a schedule and its rules

Permissions: 🔴 schedules.delete

Delete schedule › path Parameters

id

string · required

Schedule ID

Delete schedule › Responses

Schedule successfully deleted

status

string · enum

Enum values:

success

object

Replace schedule rules

PUT

https://common-api.karma.life

/api/v1/schedules/{scheduleId}/rules

Replace all rules for a schedule in a single operation

Permissions: 🟠 schedules.update

Replace schedule rules › path Parameters

scheduleId

string · required

Schedule ID

Replace schedule rules › Request Body

object[] · minItems: 1 · required

New rules to replace existing rules

Replace schedule rules › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

PUT/api/v1/schedules/{scheduleId}/rules

curl --request PUT \
  --url https://common-api.karma.life/api/v1/schedules/:scheduleId/rules \
  --header 'Content-Type: application/json' \
  --data '
{
  "rules": [
    {
      "ruleType": "WEEKDAY",
      "weekday": 0,
      "startTime": "startTime",
      "endTime": "endTime",
      "startDate": "2024-08-25",
      "endDate": "2024-08-25",
      "validFrom": "2024-08-25",
      "validTo": "2024-08-25",
      "isAvailable": true
    }
  ]
}
'

Example Request Body

{
  "rules": [
    {
      "ruleType": "WEEKDAY",
      "weekday": 0,
      "startTime": "startTime",
      "endTime": "endTime",
      "startDate": "2024-08-25",
      "endDate": "2024-08-25",
      "validFrom": "2024-08-25",
      "validTo": "2024-08-25",
      "isAvailable": true
    }
  ]
}

json

Example Responses

No example specified for this content type

application/json

Add schedule rule

POST

https://common-api.karma.life

/api/v1/schedules/{scheduleId}/rules

Add a new rule to an existing schedule

Permissions: 🟢 schedules.create

Add schedule rule › path Parameters

scheduleId

string · required

Schedule ID

Add schedule rule › Request Body

ruleType

string · enum · required

Type of schedule rule

Enum values:

WEEKDAY

DATE_RANGE

SPECIFIC_DATE

weekday

number · min: 0 · max: 6

Day of week (0=Sunday, 6=Saturday)

startTime

string · pattern: ^([0-1][0-9]|2[0-3])…

Start time in HH:MM or HH:MM:SS format (seconds are stripped)

endTime

string · pattern: ^([0-1][0-9]|2[0-3])…

End time in HH:MM or HH:MM:SS format (seconds are stripped)

startDate

string · date

Start date for date range rules

endDate

string · date

End date for date range rules

validFrom

string · date

Rule valid from date

validTo

string · date

Rule valid until date

isAvailable

boolean

Whether entity is available during this rule

Default: true

Add schedule rule › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

POST/api/v1/schedules/{scheduleId}/rules

curl --request POST \
  --url https://common-api.karma.life/api/v1/schedules/:scheduleId/rules \
  --header 'Content-Type: application/json' \
  --data '
{
  "ruleType": "WEEKDAY",
  "weekday": 0,
  "startTime": "startTime",
  "endTime": "endTime",
  "startDate": "2024-08-25",
  "endDate": "2024-08-25",
  "validFrom": "2024-08-25",
  "validTo": "2024-08-25",
  "isAvailable": true
}
'

Example Request Body

{
  "ruleType": "WEEKDAY",
  "weekday": 0,
  "startTime": "startTime",
  "endTime": "endTime",
  "startDate": "2024-08-25",
  "endDate": "2024-08-25",
  "validFrom": "2024-08-25",
  "validTo": "2024-08-25",
  "isAvailable": true
}

json

Example Responses

No example specified for this content type

application/json

Check availability

GET

https://common-api.karma.life

/api/v1/schedules/check-availability

Check entity availability at a specific time based on schedules

Check availability › query Parameters

entityType

string · enum · required

Type of entity to check

Enum values:

ITEM

LOCATION

MODIFIER

Check availability › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Update schedule rule

PUT

https://common-api.karma.life

/api/v1/schedules/rules/{ruleId}

Update an existing schedule rule

Permissions: 🟠 schedules.update

Update schedule rule › path Parameters

ruleId

string · required

Rule ID

Update schedule rule › Request Body

ruleType

string · enum

Enum values:

WEEKDAY

DATE_RANGE

SPECIFIC_DATE

weekday

number | null · min: 0 · max: 6

startTime

string | null · pattern: ^([0-1][0-9]|2[0-3])…

endTime

string | null · pattern: ^([0-1][0-9]|2[0-3])…

startDate

string | null · date

endDate

string | null · date

validFrom

string | null · date

validTo

string | null · date

isAvailable

boolean

Update schedule rule › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

PUT/api/v1/schedules/rules/{ruleId}

curl --request PUT \
  --url https://common-api.karma.life/api/v1/schedules/rules/:ruleId \
  --header 'Content-Type: application/json' \
  --data '
{
  "ruleType": "WEEKDAY",
  "weekday": 0,
  "startTime": "startTime",
  "endTime": "endTime",
  "startDate": "2024-08-25",
  "endDate": "2024-08-25",
  "validFrom": "2024-08-25",
  "validTo": "2024-08-25",
  "isAvailable": true
}
'

Example Request Body

{
  "ruleType": "WEEKDAY",
  "weekday": 0,
  "startTime": "startTime",
  "endTime": "endTime",
  "startDate": "2024-08-25",
  "endDate": "2024-08-25",
  "validFrom": "2024-08-25",
  "validTo": "2024-08-25",
  "isAvailable": true
}

json

Example Responses

No example specified for this content type

application/json

Delete schedule rule

DELETE

https://common-api.karma.life

/api/v1/schedules/rules/{ruleId}

Delete a schedule rule

Permissions: 🔴 schedules.delete

Delete schedule rule › path Parameters

ruleId

string · required

Rule ID

Delete schedule rule › Responses

Rule successfully deleted

status

string · enum

Enum values:

success

object

Webhook: Schedule created

POST

https://common-api.karma.life

/webhook/schedule.created

Fired when a new schedule is created. The full schedule object 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: Schedule created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

schedule.created

resource

string · enum · required

Enum values:

schedule

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

200

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

No data returned

POST/webhook/schedule.created

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

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "schedule.created",
  "resource": "schedule",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "entityType": "MENU",
    "entityId": "entityId",
    "locationId": 0,
    "name": "name",
    "description": "description",
    "isActive": true,
    "priority": 0,
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Webhook: Schedule updated

POST

https://common-api.karma.life

/webhook/schedule.updated

Only the modified fields appear in changes.

Webhook: Schedule updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

schedule.updated

resource

string · enum · required

Enum values:

schedule

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

200

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

No data returned

Webhook: Schedule deleted

POST

https://common-api.karma.life

/webhook/schedule.deleted

Soft delete.

Webhook: Schedule deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

schedule.deleted

resource

string · enum · required

Enum values:

schedule

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

200

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

No data returned

Webhook: Schedule rule created

POST

https://common-api.karma.life

/webhook/schedule.rule.created

Fired when a schedule rule is added. May also trigger menu-layouts.updated or location.hours.updated downstream.

Webhook: Schedule rule created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

schedule.rule.created

resource

string · enum · required

Enum values:

schedule

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: Schedule rule created › Responses

200

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

No data returned

POST/webhook/schedule.rule.created

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

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "schedule.rule.created",
  "resource": "schedule",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "scheduleId": "00000000-0000-0000-0000-000000000000",
    "rule": {}
  }
}

json

Example Responses

No example specified for this content type

Webhook: Schedule rule updated

POST

https://common-api.karma.life

/webhook/schedule.rule.updated

May also trigger menu-layouts.updated or location.hours.updated downstream.

Webhook: Schedule rule updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

schedule.rule.updated

resource

string · enum · required

Enum values:

schedule

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: Schedule rule updated › Responses

200

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

No data returned

POST/webhook/schedule.rule.updated

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

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "schedule.rule.updated",
  "resource": "schedule",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "scheduleId": "00000000-0000-0000-0000-000000000000",
    "changes": {}
  }
}

json

Example Responses

No example specified for this content type

Webhook: Schedule rule deleted

POST

https://common-api.karma.life

/webhook/schedule.rule.deleted

May also trigger menu-layouts.updated or location.hours.updated downstream.

Webhook: Schedule rule deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

schedule.rule.deleted

resource

string · enum · required

Enum values:

schedule

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: Schedule rule deleted › Responses

200

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

No data returned

POST/webhook/schedule.rule.deleted

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

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "schedule.rule.deleted",
  "resource": "schedule",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "scheduleId": "00000000-0000-0000-0000-000000000000",
    "deletedAt": "2024-08-25T15:00:00Z"
  }
}

json

Example Responses

No example specified for this content type

Roles Settlements