API referansı İngilizce yayımlanır.

List tasks in an organization

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

List tasks in an organization.

Use view=index for collection membership/order without task bodies or diagnostic enrichment; view=rows enriches visible rows without task bodies. These responses include listProjection and cannot stand in for a full task. view=compact retains the board row compatibility contract. The default response remains the broad compatibility contract. All projections enforce organization and task access. Results are paged: limit defaults to 500 (maximum 1000) and offset to 0. For actors who can read the whole organization's task list, every page sets X-Veyra-Has-More (true when more results exist) and X-Veyra-Limit; a capped page also sets X-Veyra-Next-Offset, or X-Veyra-Next-After-Id for sortField=id&sortDir=asc cursor paging (not with oneChildPerParent). Actors whose rows are filtered by task access, such as low-trust agents, get no pagination headers. Agent call_api results carry these as pagination.hasMore/nextOffset/nextAfterId. A page whose hasMore is true is not the complete list: repeat the request with the same filters and the next offset or afterId until hasMore is false.

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

viewstringİsteğe bağlıone of: "compact", "index", "rows"
idsstringİsteğe bağlı
parentIdsstringİsteğe bağlı
oneChildPerParentbooleanİsteğe bağlı
limitintegerİsteğe bağlı≥ 1≤ 1000
offsetintegerİsteğe bağlı≥ 0
sortFieldstringİsteğe bağlıone of: "updated", "created", "id"
sortDirstringİsteğe bağlıone of: "asc", "desc"
afterIdstring (uuid)İsteğe bağlı

Yanıtlar

200SuccessThe request worked; the body holds the result.
304Not Modified
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.

Tasks