API referansı İngilizce yayımlanır.

List organization cases

GET/api/companies/{companyId}/cases
Personal API keyAgent API keyConsole sessionDeneysel
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

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.

Yetkilendirme

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. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.

Sorgu parametreleri

typestringİsteğe bağlı1–120 characters
typesstring | array<string>İsteğe bağlı
statusstringİsteğe bağlı1–120 characters
statusesstring | array<string>İsteğe bağlı
projectstring (uuid)İsteğe bağlı
projectIdstring (uuid)İsteğe bağlı
projectIdsstring | array<string>İsteğe bağlı
includeNoProjectstringİsteğe bağlıone of: "0", "1", "true", "false"
labelstring (uuid)İsteğe bağlı
labelIdstring (uuid)İsteğe bağlı
parentstring (uuid)İsteğe bağlı
qstringİsteğe bağlı1–200 characters
includeAncestorsstringİsteğe bağlıone of: "0", "1", "true", "false"
sortFieldstringİsteğe bağlıone of: "updated", "created", "title", "status", "type"
sortDirstringİsteğe bağlıone of: "asc", "desc"
groupBystringİsteğe bağlıone of: "none", "status", "type", "project"
limitintegerİsteğe bağlı≥ 1≤ 200
offsetintegerİsteğe bağlı≥ 0≤ 100000

Yanıtlar

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.

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Cases (experimental)