CIcircleci
Schedule

List schedule triggers

For a given project, returns all schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions. Does not return schedule triggers associated with GitHub App pipelines. To fetch schedule triggers associated with GitHub App pipelines, use the [List pipeline definition triggers](https://circleci.com/docs/api/v2/index.html#tag/Trigger/operation/listPipelineDefinitionTriggers] endpoint.

get/project/{project-slug}/schedule

Request

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

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

page-tokenstring

A token to retrieve the next page of results.

Response

A sequence of schedules.

next_page_tokenstring required

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

Example response

{
  "items": [
    {
      "project-slug": "gh/CircleCI-Public/api-preview-docs",
      "parameters": {
        "deploy_prod": true,
        "branch": "feature/design-new-api"
      }
    }
  ]
}

Changes

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