List organization cases

GET/api/companies/{companyId}/cases
Personal API keyAgent API keyConsole sessionExperimental
Veyra Docs TeamUpdated Version 3 · History

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.

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

typestringOptional1–120 characters
typesstring | array<string>Optional
statusstringOptional1–120 characters
statusesstring | array<string>Optional
projectstring (uuid)Optional
projectIdstring (uuid)Optional
projectIdsstring | array<string>Optional
includeNoProjectstringOptionalone of: "0", "1", "true", "false"
labelstring (uuid)Optional
labelIdstring (uuid)Optional
parentstring (uuid)Optional
qstringOptional1–200 characters
includeAncestorsstringOptionalone of: "0", "1", "true", "false"
sortFieldstringOptionalone of: "updated", "created", "title", "status", "type"
sortDirstringOptionalone of: "asc", "desc"
groupBystringOptionalone of: "none", "status", "type", "project"
limitintegerOptional≥ 1≤ 200
offsetintegerOptional≥ 0≤ 100000

Responses

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.

Cases (experimental)