---
agentTools:
  projectIndex: https://octapipe.readme.io/llms.txt
---

# Read pipeline stages

**Returns the data of all pipeline stages related to the entity with pagination.**

Click on the image below to enlarge the demonstration in Postman.

![](https://files.readme.io/e87606085459382bffe7c5d868ca2f209b061203d40b1b02bf00310bab248af9-image.png)

***

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Octapipe Web API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.octapipe.com"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/pipelines/{uuid}/stages": {
      "get": {
        "summary": "Read pipeline stages",
        "description": "",
        "operationId": "read-pipeline-stages",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string",
              "default": "Bearer {token}"
            }
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "filters",
            "in": "query",
            "schema": {
              "type": "array"
            }
          },
          {
            "name": "search",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "orderBy",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "direction",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"current_page\": 1,\n    \"data\": [\n        {\n            \"uuid\": \"92ff7288-2ffc-4f1f-bfee-1de28f7ed2e6\",\n            \"name\": \"New\",\n            \"custom_fields\": null,\n            \"is_the_first_stage\": false,\n            \"is_the_final_stage\": false,\n            \"timeout\": 24,\n            \"index\": 2,\n            \"created_at\": \"2024-08-13T21:04:33.000000Z\",\n            \"updated_at\": \"2024-08-13T21:04:33.000000Z\",\n            \"deleted_at\": null,\n            \"pipeline_uuid\": \"3786995b-f137-4d57-a80f-50655969031f\"\n        },\n        {\n            \"uuid\": \"837f2a84-cc5a-4cd7-ad36-cdfda4c22065\",\n            \"name\": \"Canceled\",\n            \"custom_fields\": null,\n            \"is_the_first_stage\": false,\n            \"is_the_final_stage\": false,\n            \"timeout\": 24,\n            \"index\": 2,\n            \"created_at\": \"2024-08-13T21:05:41.000000Z\",\n            \"updated_at\": \"2024-08-13T21:05:41.000000Z\",\n            \"deleted_at\": null,\n            \"pipeline_uuid\": \"3786995b-f137-4d57-a80f-50655969031f\"\n        }\n    ],\n    \"first_page_url\": \"https://api.octapipe.dev/pipelines/b3d4b3f3-a214-4bb4-bfb2-89e5ad77304c/stages?page=1\",\n    \"from\": 1,\n    \"last_page\": 1,\n    \"last_page_url\": \"https://api.octapipe.dev/pipelines/b3d4b3f3-a214-4bb4-bfb2-89e5ad77304c/stages?page=1\",\n    \"links\": [\n        {\n            \"url\": null,\n            \"label\": \"« Previous\",\n            \"active\": false\n        },\n        {\n            \"url\": \"https://api.octapipe.dev/pipelines/b3d4b3f3-a214-4bb4-bfb2-89e5ad77304c/stages?page=1\",\n            \"label\": \"1\",\n            \"active\": true\n        },\n        {\n            \"url\": null,\n            \"label\": \"Next »\",\n            \"active\": false\n        }\n    ],\n    \"next_page_url\": null,\n    \"path\": \"https://api.octapipe.dev/pipelines/b3d4b3f3-a214-4bb4-bfb2-89e5ad77304c/stages\",\n    \"per_page\": 15,\n    \"prev_page_url\": null,\n    \"to\": 2,\n    \"total\": 2\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "current_page": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "uuid": {
                            "type": "string",
                            "example": "92ff7288-2ffc-4f1f-bfee-1de28f7ed2e6"
                          },
                          "name": {
                            "type": "string",
                            "example": "New"
                          },
                          "custom_fields": {},
                          "is_the_first_stage": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          },
                          "is_the_final_stage": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          },
                          "timeout": {
                            "type": "integer",
                            "example": 24,
                            "default": 0
                          },
                          "index": {
                            "type": "integer",
                            "example": 2,
                            "default": 0
                          },
                          "created_at": {
                            "type": "string",
                            "example": "2024-08-13T21:04:33.000000Z"
                          },
                          "updated_at": {
                            "type": "string",
                            "example": "2024-08-13T21:04:33.000000Z"
                          },
                          "deleted_at": {},
                          "pipeline_uuid": {
                            "type": "string",
                            "example": "3786995b-f137-4d57-a80f-50655969031f"
                          }
                        }
                      }
                    },
                    "first_page_url": {
                      "type": "string",
                      "example": "https://api.octapipe.dev/pipelines/b3d4b3f3-a214-4bb4-bfb2-89e5ad77304c/stages?page=1"
                    },
                    "from": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "last_page": {
                      "type": "integer",
                      "example": 1,
                      "default": 0
                    },
                    "last_page_url": {
                      "type": "string",
                      "example": "https://api.octapipe.dev/pipelines/b3d4b3f3-a214-4bb4-bfb2-89e5ad77304c/stages?page=1"
                    },
                    "links": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "url": {},
                          "label": {
                            "type": "string",
                            "example": "« Previous"
                          },
                          "active": {
                            "type": "boolean",
                            "example": false,
                            "default": true
                          }
                        }
                      }
                    },
                    "next_page_url": {},
                    "path": {
                      "type": "string",
                      "example": "https://api.octapipe.dev/pipelines/b3d4b3f3-a214-4bb4-bfb2-89e5ad77304c/stages"
                    },
                    "per_page": {
                      "type": "integer",
                      "example": 15,
                      "default": 0
                    },
                    "prev_page_url": {},
                    "to": {
                      "type": "integer",
                      "example": 2,
                      "default": 0
                    },
                    "total": {
                      "type": "integer",
                      "example": 2,
                      "default": 0
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"error\",\n    \"message\": \"Unauthorized\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "message": {
                      "type": "string",
                      "example": "Unauthorized"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "65e62af596d53300394c7a6c:66ba45fab91b0e0063398f6b"
}
```