Workspaces

Endpointhttps://api.kontorion.eu/v1

List workspaces in the active organization

GET

https://api.kontorion.eu/v1

/workspaces

Returns every workspace under the caller's active org. The roster is what the dashboard switcher renders; mode-sorted (live first, then sandbox), then by slug.

List workspaces in the active organization › Headers

X-Workspace-Id

string

Selects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.

Workspace UUID or slug.

List workspaces in the active organization › Responses

object · required

Create a workspace in the active organization

POST

https://api.kontorion.eu/v1

/workspaces

Provisions a new workspace under the caller's active org. Reserved slugs (live, sandbox) are rejected.

Create a workspace in the active organization › Headers

Idempotency-Key

string · required

Unique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Create a workspace in the active organization › Request Body

mode

string

name

string

slug

string

Create a workspace in the active organization › Responses

Created

object · required

POST/workspaces

curl --request POST \
  --url https://api.kontorion.eu/v1/workspaces \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <string>' \
  --data '
{
  "mode": "mode",
  "name": "name",
  "slug": "slug"
}
'

shell

Example Request Body

{
  "mode": "mode",
  "name": "name",
  "slug": "slug"
}

json

Example Responses

{
  "data": {
    "active_test_clock_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "created_at": "2024-08-25T15:00:00Z",
    "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "mode": "mode",
    "name": "name",
    "organization_id": "0f8fad5b-d9cb-469f-a165-70867728950e",
    "slug": "slug",
    "status": "status",
    "updated_at": "2024-08-25T15:00:00Z"
  }
}

json

application/json

Fetch a workspace by ID or slug

GET

https://api.kontorion.eu/v1

/workspaces/{id_or_slug}

Fetch a workspace by ID or slug › path Parameters

id_or_slug

string · required

Workspace UUID or slug

Fetch a workspace by ID or slug › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Fetch a workspace by ID or slug › Responses

object · required

Delete a workspace

DELETE

https://api.kontorion.eu/v1

/workspaces/{id_or_slug}

Removes a workspace. Reserved-slug workspaces (live, sandbox) cannot be deleted - the org always has a live + sandbox pair.

Delete a workspace › path Parameters

id_or_slug

string · required

Workspace UUID or slug

Delete a workspace › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Delete a workspace › Responses

No Content

No data returned

Update a workspace

PATCH

https://api.kontorion.eu/v1

/workspaces/{id_or_slug}

Changes the editable workspace fields (name, status). Slug and mode are immutable.

Update a workspace › path Parameters

id_or_slug

string · required

Workspace UUID or slug

Update a workspace › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update a workspace › Request Body

name

string

status

string

Update a workspace › Responses

object · required

Webhook Endpoints

List workspaces in the active organization

GET

https://api.kontorion.eu/v1

/workspaces

Returns every workspace under the caller's active org. The roster is what the dashboard switcher renders; mode-sorted (live first, then sandbox), then by slug.

List workspaces in the active organization › Headers

X-Workspace-Id

string

Workspace UUID or slug.

List workspaces in the active organization › Responses

object · required

Create a workspace in the active organization

POST

https://api.kontorion.eu/v1

/workspaces

Provisions a new workspace under the caller's active org. Reserved slugs (live, sandbox) are rejected.

Create a workspace in the active organization › Headers

Idempotency-Key

string · required

Client-generated idempotency key (e.g. a UUID).

X-Workspace-Id

string

Workspace UUID or slug.

Create a workspace in the active organization › Request Body

mode

string

name

string

slug

string

Create a workspace in the active organization › Responses

Created

object · required

Fetch a workspace by ID or slug

GET

https://api.kontorion.eu/v1

/workspaces/{id_or_slug}

Fetch a workspace by ID or slug › path Parameters

id_or_slug

string · required

Workspace UUID or slug

Fetch a workspace by ID or slug › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Fetch a workspace by ID or slug › Responses

object · required

Delete a workspace

DELETE

https://api.kontorion.eu/v1

/workspaces/{id_or_slug}

Removes a workspace. Reserved-slug workspaces (live, sandbox) cannot be deleted - the org always has a live + sandbox pair.

Delete a workspace › path Parameters

id_or_slug

string · required

Workspace UUID or slug

Delete a workspace › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Delete a workspace › Responses

No Content

No data returned

Update a workspace

PATCH

https://api.kontorion.eu/v1

/workspaces/{id_or_slug}

Changes the editable workspace fields (name, status). Slug and mode are immutable.

Update a workspace › path Parameters

id_or_slug

string · required

Workspace UUID or slug

Update a workspace › Headers

X-Workspace-Id

string

Workspace UUID or slug.

Update a workspace › Request Body

name

string

status

string

Update a workspace › Responses

object · required