Location Maps

Server

Download schema

Floor plans and seating layouts

List location maps

GET

https://common-api.karma.life

/api/v1/location-maps

List location maps with optional filtering

Permissions: 🔵 location_maps.read

List location maps › query Parameters

locationId

number

Filter by location ID

List location maps › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Create location map

POST

https://common-api.karma.life

/api/v1/location-maps

Create a new location map

Permissions: 🟢 location_maps.create

Create location map › Request Body

locationId

number · required

Location ID

object · required

JSON object with map configuration

Create location map › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Get location map

GET

https://common-api.karma.life

/api/v1/location-maps/{id}

Get a single location map by ID

Permissions: 🔵 location_maps.read

Get location map › path Parameters

id

string · uuid · required

Location map UUID

Get location map › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Update location map

PUT

https://common-api.karma.life

/api/v1/location-maps/{id}

Update an existing location map

Permissions: 🟠 location_maps.update

Update location map › path Parameters

id

string · uuid · required

Location map UUID

Update location map › Request Body

object · required

Updated JSON object with map configuration

Update location map › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Delete location map

DELETE

https://common-api.karma.life

/api/v1/location-maps/{id}

Delete a location map

Permissions: 🔴 location_maps.delete

Delete location map › path Parameters

id

string · uuid · required

Location map UUID

Delete location map › Responses

Location map successfully deleted

status

string · enum

Enum values:

success

object

Webhook: Location map created

POST

https://common-api.karma.life

/webhook/location_maps.created

Fired when a new location map (floor plan / seating layout) is created.

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: Location map created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

location_maps.created

resource

string · enum · required

Enum values:

location_maps

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

200

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

No data returned

Webhook: Location map updated

POST

https://common-api.karma.life

/webhook/location_maps.updated

Only the modified fields appear in changes.

Webhook: Location map updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

location_maps.updated

resource

string · enum · required

Enum values:

location_maps

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

200

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

No data returned

POST/webhook/location_maps.updated

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

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "location_maps.updated",
  "resource": "location_maps",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "changes": {},
    "locationId": 0
  }
}

json

Example Responses

No example specified for this content type

Webhook: Location map deleted

POST

https://common-api.karma.life

/webhook/location_maps.deleted

Soft delete.

Webhook: Location map deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

location_maps.deleted

resource

string · enum · required

Enum values:

location_maps

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

200

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

No data returned

POST/webhook/location_maps.deleted

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

Example Request Body

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

json

Example Responses

No example specified for this content type

Invoices Locations

Karma Common API

Location Maps

Server

Download schema

Floor plans and seating layouts

List location maps

GET

https://common-api.karma.life

/api/v1/location-maps

List location maps with optional filtering

Permissions: 🔵 location_maps.read

List location maps › query Parameters

locationId

number

Filter by location ID

List location maps › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Create location map

POST

https://common-api.karma.life

/api/v1/location-maps

Create a new location map

Permissions: 🟢 location_maps.create

Create location map › Request Body

locationId

number · required

Location ID

object · required

JSON object with map configuration

Create location map › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Get location map

GET

https://common-api.karma.life

/api/v1/location-maps/{id}

Get a single location map by ID

Permissions: 🔵 location_maps.read

Get location map › path Parameters

id

string · uuid · required

Location map UUID

Get location map › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Update location map

PUT

https://common-api.karma.life

/api/v1/location-maps/{id}

Update an existing location map

Permissions: 🟠 location_maps.update

Update location map › path Parameters

id

string · uuid · required

Location map UUID

Update location map › Request Body

object · required

Updated JSON object with map configuration

Update location map › Responses

Default Response

status

string · enum · required

Enum values:

success

object · required

Delete location map

DELETE

https://common-api.karma.life

/api/v1/location-maps/{id}

Delete a location map

Permissions: 🔴 location_maps.delete

Delete location map › path Parameters

id

string · uuid · required

Location map UUID

Delete location map › Responses

Location map successfully deleted

status

string · enum

Enum values:

success

object

Webhook: Location map created

POST

https://common-api.karma.life

/webhook/location_maps.created

Fired when a new location map (floor plan / seating layout) is created.

Webhook: Location map created › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

location_maps.created

resource

string · enum · required

Enum values:

location_maps

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

200

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

No data returned

Webhook: Location map updated

POST

https://common-api.karma.life

/webhook/location_maps.updated

Only the modified fields appear in changes.

Webhook: Location map updated › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

location_maps.updated

resource

string · enum · required

Enum values:

location_maps

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

200

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

No data returned

POST/webhook/location_maps.updated

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

Example Request Body

{
  "id": "evt_01HZK3...",
  "event": "location_maps.updated",
  "resource": "location_maps",
  "resourceId": "resourceId",
  "timestamp": "2024-08-25T15:00:00Z",
  "apiVersion": "v1",
  "data": {
    "changes": {},
    "locationId": 0
  }
}

json

Example Responses

No example specified for this content type

Webhook: Location map deleted

POST

https://common-api.karma.life

/webhook/location_maps.deleted

Soft delete.

Webhook: Location map deleted › Request Body

Standard envelope wrapping every outbound webhook event.

id

string · required

Unique webhook delivery ID

event

string · enum · required

Enum values:

location_maps.deleted

resource

string · enum · required

Enum values:

location_maps

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

200

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

No data returned

POST/webhook/location_maps.deleted

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

Example Request Body

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

json

Example Responses

No example specified for this content type

Invoices Locations