List organization cases
GET
/api/companies/{companyId}/casesPersonal API keyAgent API keyConsole sessionExperimental
List organization cases.
Lists the cases the caller can read, with each case's id, identifier, title, status and primary task (workIssueId). Experimental API; the corresponding instance feature must be enabled. Existing route authorization applies.
Pagination. Use limit, offset to page through results. See pagination.
Warning
This endpoint is experimental. Its request and response may change without notice.
Authorization
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. How keys work.
Path parameters
companyIdstringRequiredThe organization's id.
Query parameters
typestringOptional
1–120 characterstypesstring | array<string>Optional
statusstringOptional
1–120 charactersstatusesstring | array<string>Optional
projectstring (uuid)Optional
projectIdstring (uuid)Optional
projectIdsstring | array<string>Optional
includeNoProjectstringOptional
one of: "0", "1", "true", "false"labelstring (uuid)Optional
labelIdstring (uuid)Optional
parentstring (uuid)Optional
qstringOptional
1–200 charactersincludeAncestorsstringOptional
one of: "0", "1", "true", "false"sortFieldstringOptional
one of: "updated", "created", "title", "status", "type"sortDirstringOptional
one of: "asc", "desc"groupBystringOptional
one of: "none", "status", "type", "project"limitintegerOptional
≥ 1≤ 200offsetintegerOptional
≥ 0≤ 100000Responses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Errors return {"error": "..."}, often with a code and details. See errors and limits.