Workspaces

Get a workspace

get

Retrieve a workspace by ID. Requires Workspace.view permission.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

slugstringRequired

namestringRequired

backend_org_idstring · nullableRequired

regionstringRequired

connector_typestring · nullableRequired

timezonestring · nullableRequired

topic_modeling_enabledbooleanRequired

delta_sharing_enabledbooleanRequired

delta_sharing_modestring · enumRequiredPossible values:

delta_sharing_identifierstring · nullableRequired

provisioned_atstring · date-time · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Workspace not found.

get/v1/workspaces/{workspace_id}

GET /v1/workspaces/{workspace_id} HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "name": "text",
  "backend_org_id": "text",
  "region": "text",
  "connector_type": "text",
  "timezone": "text",
  "topic_modeling_enabled": true,
  "delta_sharing_enabled": true,
  "delta_sharing_mode": "open",
  "delta_sharing_identifier": "text",
  "provisioned_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Update a workspace

patch

Update workspace fields. Requires Workspace.update permission.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

namestring · min: 1 · nullableOptional

topic_modeling_enabledboolean · nullableOptional

delta_sharing_enabledboolean · nullableOptional

delta_sharing_modestring · enumOptionalPossible values:

delta_sharing_identifierstring · min: 1 · max: 512Optional

timezonestring · min: 1 · max: 64 · nullableOptional

regionstring · enum · nullableOptionalPossible values:

connector_typestring · enum · nullableOptionalPossible values:

Responses

200

Successful Response

application/json

idstring · uuidRequired

slugstringRequired

namestringRequired

backend_org_idstring · nullableRequired

regionstringRequired

connector_typestring · nullableRequired

timezonestring · nullableRequired

topic_modeling_enabledbooleanRequired

delta_sharing_enabledbooleanRequired

delta_sharing_modestring · enumRequiredPossible values:

delta_sharing_identifierstring · nullableRequired

provisioned_atstring · date-time · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Insufficient permissions.

404

Workspace not found.

422

Invalid request body.

503

Revocation could not be queued; retry the request.

patch/v1/workspaces/{workspace_id}

PATCH /v1/workspaces/{workspace_id} HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "name": "text",
  "topic_modeling_enabled": true,
  "delta_sharing_enabled": true,
  "delta_sharing_mode": "open",
  "delta_sharing_identifier": "text",
  "timezone": "text",
  "region": "us-east-1",
  "connector_type": "epic"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "name": "text",
  "backend_org_id": "text",
  "region": "text",
  "connector_type": "text",
  "timezone": "text",
  "topic_modeling_enabled": true,
  "delta_sharing_enabled": true,
  "delta_sharing_mode": "open",
  "delta_sharing_identifier": "text",
  "provisioned_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

List workspaces

get

List workspaces accessible to this API key. Requires Workspace.view permission.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Query parameters

limitinteger · max: 200OptionalDefault: 50

continuation_tokenanyOptional

Responses

200

Successful Response

application/json

has_morebooleanRequired

continuation_tokenanyOptional

401

Missing or invalid API key.

403

Insufficient permissions.

422

Validation Error

application/json

get/v1/workspaces

GET /v1/workspaces HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "slug": "text",
      "name": "text",
      "backend_org_id": "text",
      "region": "text",
      "connector_type": "text",
      "timezone": "text",
      "topic_modeling_enabled": true,
      "delta_sharing_enabled": true,
      "delta_sharing_mode": "open",
      "delta_sharing_identifier": "text",
      "provisioned_at": "2026-01-01T00:00:00.000Z",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "has_more": true,
  "continuation_token": null
}

Provision workspace resources

post

Seed default integrations and mark workspace as provisioned. Idempotent. Requires Workspace.update permission.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

401

Missing or invalid API key.

403

Insufficient permissions.

404

Workspace not found.

post/v1/workspaces/{workspace_id}/provision

POST /v1/workspaces/{workspace_id}/provision HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "workspace": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "slug": "text",
    "name": "text",
    "backend_org_id": "text",
    "region": "text",
    "connector_type": "text",
    "timezone": "text",
    "topic_modeling_enabled": true,
    "delta_sharing_enabled": true,
    "delta_sharing_mode": "open",
    "delta_sharing_identifier": "text",
    "provisioned_at": "2026-01-01T00:00:00.000Z",
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z"
  }
}

Archive a workspace

post

Archive a workspace and remove it from active access flows while preserving underlying data. Requires owner access and slug confirmation.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

slugstring · min: 2 · max: 63RequiredPattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$

Responses

200

Successful Response

application/json

idstring · uuidRequired

slugstringRequired

namestringRequired

backend_org_idstring · nullableRequired

regionstringRequired

connector_typestring · nullableRequired

timezonestring · nullableRequired

topic_modeling_enabledbooleanRequired

delta_sharing_enabledbooleanRequired

delta_sharing_modestring · enumRequiredPossible values:

delta_sharing_identifierstring · nullableRequired

provisioned_atstring · date-time · nullableRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

401

Missing or invalid API key.

403

Only owners can archive a workspace.

404

Workspace not found.

422

Workspace slug confirmation did not match.

post/v1/workspaces/{workspace_id}/archive

POST /v1/workspaces/{workspace_id}/archive HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "slug": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "name": "text",
  "backend_org_id": "text",
  "region": "text",
  "connector_type": "text",
  "timezone": "text",
  "topic_modeling_enabled": true,
  "delta_sharing_enabled": true,
  "delta_sharing_mode": "open",
  "delta_sharing_identifier": "text",
  "provisioned_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Get test caller numbers

get

Get phone numbers configured as test callers for this workspace.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

numbersstring[]Required

get/v1/workspaces/{workspace_id}/test-caller-numbers

GET /v1/workspaces/{workspace_id}/test-caller-numbers HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "numbers": [
    "text"
  ]
}

Update test caller numbers

put

Set phone numbers to be treated as test callers. Calls from these numbers are tagged source='test' and excluded from billing, scores, analytics, outbound EHR sync, and entity views.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

numbersstring[] · max: 100Required

Responses

200

Successful Response

application/json

numbersstring[]Required

422

Validation Error

application/json

put/v1/workspaces/{workspace_id}/test-caller-numbers

PUT /v1/workspaces/{workspace_id}/test-caller-numbers HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "numbers": [
    "text"
  ]
}

{
  "numbers": [
    "text"
  ]
}

Get test credential IDs

get

Get the credential IDs configured as test principals for this workspace's text channel.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Responses

200

Successful Response

application/json

credential_idsstring · uuid[]Required

get/v1/workspaces/{workspace_id}/test-credential-ids

GET /v1/workspaces/{workspace_id}/test-credential-ids HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

{
  "credential_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Update test credential IDs

put

Set credential IDs to be treated as test principals. Text turns from these credentials are tagged source='test' and excluded from billing, scores, analytics, outbound EHR sync, and entity views.

Authorizations

AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters

workspace_idstring · uuidRequired

Body

credential_idsstring · uuid[] · max: 100Required

Responses

200

Successful Response

application/json

credential_idsstring · uuid[]Required

422

Validation Error

application/json

put/v1/workspaces/{workspace_id}/test-credential-ids

PUT /v1/workspaces/{workspace_id}/test-credential-ids HTTP/1.1
Host: platform.api-us.concurrence.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "credential_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "credential_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}