v1

latestOpenAPI 3.0.3MIT2026-07-1411163326.7 KB
Pipeline

Get all pipelines

Returns all pipelines for this project.

get/project/{project-slug}/pipeline

Path parameters

project-slugstring required

Project slug in the form vcs-slug/org-name/repo-name. The / characters may be URL-escaped. For projects that use GitLab or GitHub App, use circleci as the vcs-slug, replace org-name with the organization ID (found in Organization Settings), and replace repo-name with the project ID (found in Project Settings).

Query parameters

branchstring

The name of a vcs branch.

page-tokenstring

A token to retrieve the next page of results.

Response

A sequence of pipelines.

next_page_tokenstring required

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

Example response

{
  "items": [
    {
      "id": "5034460f-c7c4-4c43-9457-de07e2029e7b",
      "project_slug": "gh/CircleCI-Public/api-preview-docs",
      "number": 25,
      "vcs": {
        "provider_name": "GitHub",
        "target_repository_url": "https://github.com/CircleCI-Public/api-preview-docs",
        "branch": "feature/design-new-api",
        "review_id": "123",
        "review_url": "https://github.com/CircleCI-Public/api-preview-docs/pull/123",
        "revision": "f454a02b5d10fcccfd7d9dd7608a76d6493a98b4",
        "tag": "v3.1.4159",
        "origin_repository_url": "https://github.com/CircleCI-Public/api-preview-docs"
      }
    }
  ]
}