CIcircleci
Workflow

Get a workflow's jobs

Returns a sequence of jobs for a workflow.

get/workflow/{id}/job

Request

  • Base URL
    https://circleci.com/api/v2
  • URL
    https://circleci.com/api/v2/workflow/{id}/job
  • Auth
    • API key in header Circle-Token
    • or HTTP bearer
    • or HTTP basic
    • or API key in query parameter circle-token

Path parameters

idstring uuid required

The unique ID of the workflow.

Response

A paginated sequence of jobs.

next_page_tokenstring required

A token to pass as a page-token query parameter to return the next page of results.

Example response

{
  "items": [
    {
      "job_number": 1,
      "project_slug": "gh/CircleCI-Public/api-preview-docs",
      "requires": {
        "d212e286-9962-4ed7-92e2-8699622ed720": [
          "success"
        ],
        "74be7583-44de-42a6-be75-8344de52a6f2": [
          "failed",
          "canceled"
        ],
        "a3349b77-90f7-4a39-b49b-7790f7da3943": [
          "success",
          "failed",
          "canceled"
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.