Справочник API публикуется на английском языке.

List organization cases

GET/api/companies/{companyId}/cases
Personal API keyAgent API keyConsole sessionЭкспериментальный
Veyra Docs TeamОбновлено Версия 3 · История

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.

Авторизация

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. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Параметры запроса

typestringНеобязательный1–120 characters
typesstring | array<string>Необязательный
statusstringНеобязательный1–120 characters
statusesstring | array<string>Необязательный
projectstring (uuid)Необязательный
projectIdstring (uuid)Необязательный
projectIdsstring | array<string>Необязательный
includeNoProjectstringНеобязательныйone of: "0", "1", "true", "false"
labelstring (uuid)Необязательный
labelIdstring (uuid)Необязательный
parentstring (uuid)Необязательный
qstringНеобязательный1–200 characters
includeAncestorsstringНеобязательныйone of: "0", "1", "true", "false"
sortFieldstringНеобязательныйone of: "updated", "created", "title", "status", "type"
sortDirstringНеобязательныйone of: "asc", "desc"
groupBystringНеобязательныйone of: "none", "status", "type", "project"
limitintegerНеобязательный≥ 1≤ 200
offsetintegerНеобязательный≥ 0≤ 100000

Ответы

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.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Cases (experimental)