List

GET
/workspaces
/:domain
/projects
/:project_name
/pipelines

Returns all pipelines from the specified project. Pipelines hidden using visibility settings are not included.

Request

REQUIRED SCOPES

WORKSPACE, EXECUTION_INFO

URL PARAMETERS

domainrequired string

The workspace domain.

project_namerequired string

The name ID of the project.

GET PARAMETERS

pageinteger

The number of the successive page (results are splitted by pages of per_page elements each).

per_pageinteger

The number of returned elements on the page.

sort_bystring

Specifies the ordering. Can be one of name or id.

sort_directionstring

Specifies the direction of the ordering. Can be one of ASC or DESC.

Last modified on Oct 7, 2024

Get Edit

Example:

CURL
  curl -X GET "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines" \
      -H "Authorization: Bearer <YOUR-TOKEN>" \
      -H "Content-Type: application/json" \

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines",
  "pipelines": [
    {
      "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
      "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
      "id": 2,
      "name": "dev",
      "on": "CLICK",
      "refs": [
        "refs/heads/master"
      ],
      "last_execution_status": "SUCCESSFUL",
      "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
    }
  ]
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999