GitLab API icon

GitLab API

Gitlab

Actions1062

Projects → getApiV4ProjectsIdPipelineSchedules

AI-generated

Summary

Retrieve a list of pipeline schedules for a specific GitLab project, optionally filtered by scope and paginated.

Inputs

  • id (required) — The ID or URL-encoded path of the GitLab project from which to fetch pipeline schedules.
  • page — The page number to retrieve in paginated results, defaults to 1 if not provided.
  • per_page — The number of pipeline schedules to return per page, defaults to 20 if not specified.
  • scope — Filter pipeline schedules by their scope; valid values are 'active' or 'inactive'.

Output shape

a list of pipeline schedule objects associated with the specified project

Supports pagination through 'page' and 'per_page' query parameters. The 'scope' parameter filters schedules by status. Authentication is required unless 'Skip Authentication' is enabled.

Examples

Example 1: Fetch the first page of active pipeline schedules for project with ID 18

Set 'id' to '18', 'scope' to 'active', optionally set 'page' to '1' and 'per_page' to '20' (or omit to use defaults).

Example 2: Retrieve all pipeline schedules regardless of their status for a specific project

Set 'id' to the project identifier and omit 'scope' parameter to get both active and inactive schedules.

Links

Discussion