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

List bounded execution workspace overview rows for an organization

GET/api/companies/{companyId}/workspace-overview
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

List bounded execution workspace overview rows for an organization.

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.

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

projectIdstring (uuid)Необязательный
statusanyОбязательный
limitintegerНеобязательный≥ 1≤ 100
offsetintegerНеобязательный≥ 0

Ответы

200SuccessThe request worked; the body holds the result.
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.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

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

Workspaces