La referencia de la API se publica en inglés.

List organization cases

GET/api/companies/{companyId}/cases
Personal API keyAgent API keyConsole sessionExperimental
Veyra Docs TeamActualizado el Versión 3 · Historial

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.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Parámetros de consulta

typestringOpcional1–120 characters
typesstring | array<string>Opcional
statusstringOpcional1–120 characters
statusesstring | array<string>Opcional
projectstring (uuid)Opcional
projectIdstring (uuid)Opcional
projectIdsstring | array<string>Opcional
includeNoProjectstringOpcionalone of: "0", "1", "true", "false"
labelstring (uuid)Opcional
labelIdstring (uuid)Opcional
parentstring (uuid)Opcional
qstringOpcional1–200 characters
includeAncestorsstringOpcionalone of: "0", "1", "true", "false"
sortFieldstringOpcionalone of: "updated", "created", "title", "status", "type"
sortDirstringOpcionalone of: "asc", "desc"
groupBystringOpcionalone of: "none", "status", "type", "project"
limitintegerOpcional≥ 1≤ 200
offsetintegerOpcional≥ 0≤ 100000

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Cases (experimental)