CIcircleci
Schedule

Get a schedule by ID. Available only on schedules associated with GitHub OAuth or Bitbucket Cloud pipeline definitions.

Get a schedule by id.

get/schedule/{schedule-id}

Request

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

Path parameters

schedule-idstring uuid required

The unique ID of the schedule.

Response

A schedule object.

idstring uuid required

The unique ID of the schedule.

updated-atstring date-time required

The date and time the pipeline was last updated.

namestring required

Name of the schedule.

created-atstring date-time required

The date and time the pipeline was created.

project-slugstring required

The project-slug for the schedule

parametersobject required

Pipeline parameters represented as key-value pairs. Must contain branch or tag.

descriptionstring required

Description of the schedule.

Example response

{
  "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.