List bounded execution workspace overview rows for an organization

GET/api/companies/{companyId}/workspace-overview
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

List bounded execution workspace overview rows for an organization.

Pagination. Use limit, offset to page through results. See pagination.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Query parameters

projectIdstring (uuid)Optional
statusanyRequired
limitintegerOptional≥ 1≤ 100
offsetintegerOptional≥ 0

Responses

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).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Workspaces