List heartbeats
GET /v1/heartbeats · SDK listHeartbeats · CLI deployments heartbeat list
Requires schedules:read.
AuthorizationBearer <token>Opaque bearer credential scoped to one service account and tenant.
cursor?stringOpaque cursor returned by the previous page.
1 <= length <= 4096limit?integerMaximum number of resources to return.
1 <= value <= 100x-deployments-environment?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-organization?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-project?stringRequired with a platform bearer JWT, where the three tenant headers select an environment the caller can access through active organization membership. Optional with an API key; when supplied, it must match the key's tenant.
^[0-7][0-9A-HJKMNP-TV-Z]{25}$ListHeartbeatsResponse
application/json- response
heartbeats*array<>nextCursor?|nullcurl -X GET "https://example.com/v1/heartbeats"{ "heartbeats": [ { "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "environmentId": "string", "organizationId": "string", "projectId": "string", "workspaceId": "string", "activeWindow": { "daysOfWeek": [ 0 ], "endMinuteOfDay": 0, "startMinuteOfDay": 1439 }, "agentDeploymentId": "string", "createdBy": { "id": "string", "type": "agent" }, "id": "string", "lastRunAt": "2019-08-24T14:15:22Z", "nextRunAt": "2019-08-24T14:15:22Z", "object": "heartbeat", "schedule": { "instructions": "string", "intervalMs": 60000, "skipWhenBusy": true, "timezone": "string" }, "status": "active", "threadId": "string" } ], "nextCursor": "string"}