GitLab API icon

GitLab API

Gitlab

Actions1062

Projects → getApiV4ProjectsIdPipelines

AI-generated

Summary

Retrieve a list of pipelines for a specific GitLab project, filtered and paginated according to optional query parameters.

Inputs

  • id (required) — The project ID or URL-encoded path identifying the project whose pipelines you want to fetch.
  • page — The page number of results to retrieve for paginated responses.
  • per_page — The number of pipeline items to return per page.
  • scope — Filter pipelines by scope (running, pending, finished, branches, tags).
  • status — Filter pipelines by their status, e.g. running, success, failed, canceled, etc.
  • ref — Filter pipelines by the reference name (branch or tag).
  • sha — Filter pipelines by specific commit SHA.
  • yaml_errors — Return pipelines with invalid configurations if set true.
  • username — Filter pipelines triggered by a specific user username.
  • updated_before — Return pipelines updated before this ISO 8601 datetime.
  • updated_after — Return pipelines updated after this ISO 8601 datetime.
  • order_by — Order pipelines by id, status, ref, updated_at, or user_id.
  • sort — Sort order: ascending or descending.
  • source — Filter pipelines by their source, e.g., push, web, trigger, schedule, api, etc.
  • name — Filter pipelines by name.

Output shape

a list (array) of pipeline objects as returned by GitLab's API v4 for the specified project

The output is paginated according to the page and per_page parameters. If no filters are applied, it returns the pipelines for the project in descending order by default (id desc). Authentication is required unless Skip Authentication is enabled.

Examples

Example 1: Fetch first page of pipelines for project ID 11 with default pagination and no filters.

Set 'id' path parameter to '11'. Leave other query parameters empty or default.

Links

Discussion