CTctrlplanedev

List jobs for a job agent

Changed on

Returns the jobs assigned to a job agent, optionally filtered by status.

get/v1/workspaces/{workspaceId}/job-agents/{jobAgentId}/jobs

Request

  • Base URL
    http://localhost:3001/api
  • URL
    http://localhost:3001/api/v1/workspaces/{workspaceId}/job-agents/{jobAgentId}/jobs
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

workspaceIdstring required

ID of the workspace

jobAgentIdstring required

ID of the job agent

Query parameters

status'cancelled' | 'skipped' | 'inProgress' | 'actionRequired' | 'pending' | 'failure' | 'invalidJobAgent' | 'invalidIntegration' | 'externalRunNotFound' | 'successful' | 'queued'

Filter jobs by status

includeDispatchContextboolean

Include the dispatch context on each job. It can be large, so it is omitted by default.

limitinteger

Maximum number of items to return

offsetinteger

Number of items to skip

Response

Paginated list of items

limitinteger required

Maximum number of items returned

offsetinteger required

Number of items skipped

totalinteger required

Total number of items available

Changes