Get a case

GET

/api/cases/{id}

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

The case.

object

id

string format: uuid

workspaceId

string format: uuid

contactId

string format: uuid

accountId

string | null format: uuid

caseType

string

status

Open, resolved, or closed.

string

outcome

string | null

businessValue

string | null

businessValueCurrency

string | null

artifactKey

string | null

artifactValue

string | null

workflowId

string | null

parentCaseId

string | null format: uuid

contactName

string | null

accountName

string | null

openedAt

string format: date-time

resolvedAt

string | null format: date-time

closedAt

string | null format: date-time

createdAt

string format: date-time

updatedAt

string format: date-time

404

Case not found.

Standard error response returned by all endpoints on failure.

object

error

required

A human-readable error message describing what went wrong.

string

Example

Conversation not found

code

A machine-readable reason on some refusals, for example ‘key_lock’ when an API key’s brand or workspace restriction does not cover the action.

string

Example

key_lock

missing_scopes

On a 403 for an API key without a scope the endpoint requires: the scopes the key lacks.

Array<string>

Example

[
  "mcp:write"
]

entryId

On a 409 with code duplicate_question or duplicate_rule_text: the knowledge base entry or policy that already holds the question or rule text.

string format: uuid

Example

11223344-5566-4788-99aa-bbccddeeff00

connectionId

On a 422 about one MCP connection a request names, from an assignment or an agent create or update (a connection that does not exist, one listed twice, or one that does not declare a tool named): the connection, as the request named it.

string

undeclaredTools

On the same 422: the tool names the connection does not declare.

Array<string>

Example

[
  "get_orders"
]

declaredTools

On the same 422: the tools the connection declares.

Array<string>

Example

[
  "get_order",
  "search_orders"
]