Sign in
Case

Get a case

Get the case of the given ID.

get/cases/{id}

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

The ID of the case. The ID is returned from GET /v1.0/cases response.

Response

Successful response.

idstring uuid

Unique identifier for the case.

customer_idstring uuid

Unique identifier of the associated customer.

peer_typestring

Remote endpoint type (e.g. "tel", "email") this case is scoped to.

peer_targetstring

Remote endpoint address (normalized, e.g. "+155****4567").

reference_typestring

Origin channel type (e.g. "call", "conversation_message").

contact_idstring uuid

The resolved contact this case is attributed to. Nullable until resolved.

owner_typestring

Type of the case owner.

owner_idstring uuid

ID of the case owner.

status'open' | 'closed'

Case lifecycle status.

opened_atstring date-time

Timestamp when the case was opened. Nullable.

closed_atstring date-time

Timestamp when the case was closed. Nullable.

closed_reasonstring

Reason the case was closed (e.g. "agent_closed", "timeout").

closed_by_typestring

Type of the actor that closed the case (e.g. "agent", "system").

closed_by_idstring uuid

ID of the actor that closed the case. Nullable.

previous_case_idstring uuid

ID of the prior (now-closed) case this case continues from, if any.

tm_createstring date-time

Timestamp when this case was created.

tm_updatestring date-time

Timestamp when this case was last updated.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "peer_type": "tel",
  "peer_target": "+155****4567",
  "reference_type": "call",
  "contact_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "owner_type": "agent",
  "owner_id": "2a2ec0ba-8004-11ec-aea5-439829c92a7c",
  "status": "open",
  "opened_at": "2026-06-01T09:30:00.000000Z",
  "closed_at": "2026-06-02T09:30:00.000000Z",
  "closed_reason": "agent_closed",
  "closed_by_type": "agent",
  "closed_by_id": "2a2ec0ba-8004-11ec-aea5-439829c92a7c",
  "previous_case_id": "11111111-0000-0000-0000-000000000001",
  "tm_create": "2026-06-01T09:30:00.000000Z",
  "tm_update": "2026-06-01T09:30:00.000000Z"
}

Changes