La référence de l'API est publiée en anglais.

List organization cases

GET/api/companies/{companyId}/cases
Personal API keyAgent API keyConsole sessionExpérimental
Veyra Docs TeamMis à jour le Version 3 · Historique

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.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.

Paramètres de requête

typestringFacultatif1–120 characters
typesstring | array<string>Facultatif
statusstringFacultatif1–120 characters
statusesstring | array<string>Facultatif
projectstring (uuid)Facultatif
projectIdstring (uuid)Facultatif
projectIdsstring | array<string>Facultatif
includeNoProjectstringFacultatifone of: "0", "1", "true", "false"
labelstring (uuid)Facultatif
labelIdstring (uuid)Facultatif
parentstring (uuid)Facultatif
qstringFacultatif1–200 characters
includeAncestorsstringFacultatifone of: "0", "1", "true", "false"
sortFieldstringFacultatifone of: "updated", "created", "title", "status", "type"
sortDirstringFacultatifone of: "asc", "desc"
groupBystringFacultatifone of: "none", "status", "type", "project"
limitintegerFacultatif≥ 1≤ 200
offsetintegerFacultatif≥ 0≤ 100000

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Cases (experimental)