List runs for an organization

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

List runs for an organization.

Pagination. Use limit 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

agentIdstringOptional
limitintegerOptional≥ 1≤ 1000
summarystringOptionalone of: "0", "1", "true", "false"
latestFailuresOnlystringOptionalone of: "true", "false"

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.

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

Runs