> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.sevalla.com/llms.txt > Use this file to discover all available pages before exploring further. # Get pipeline > Retrieve the full details of a pipeline including all its stages. Use this to inspect the pipeline configuration, stage ordering, and preview settings. ## OpenAPI ````yaml https://api.sevalla.com/v3/openapi.json get /pipelines/{id} openapi: 3.1.0 info: title: Sevalla API docs version: 1.0.0 servers: - url: https://api.sevalla.com/v3 security: - bearerAuth: [] paths: /pipelines/{id}: get: tags: - Pipelines summary: Get pipeline description: >- Retrieve the full details of a pipeline including all its stages. Use this to inspect the pipeline configuration, stage ordering, and preview settings. operationId: getPipelineV3 parameters: - schema: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ example: fb5e5168-4281-4bec-94c5-0d1584e9e657 in: path name: id required: true description: Pipeline identifier responses: '200': description: Default Response content: application/json: schema: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Unique identifier for the pipeline example: fb5e5168-4281-4bec-94c5-0d1584e9e657 company_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Identifier of the company that owns this pipeline example: fb5e5168-4281-4bec-94c5-0d1584e9e657 project_id: anyOf: - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ - type: 'null' description: Identifier of the project this pipeline is grouped under example: fb5e5168-4281-4bec-94c5-0d1584e9e657 display_name: type: string description: >- Human-readable name for the pipeline shown in the dashboard example: My Pipeline type: type: string enum: - trunk - branch description: >- Pipeline type. `trunk` - all stages share the same Git repository and branch configuration. `branch` - each stage can have its own branch. example: trunk stages: type: array items: type: object properties: id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Unique identifier for the pipeline stage example: fb5e5168-4281-4bec-94c5-0d1584e9e657 pipeline_id: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ description: Identifier of the pipeline this stage belongs to example: fb5e5168-4281-4bec-94c5-0d1584e9e657 display_name: type: string description: >- Human-readable name for the stage shown in the dashboard example: Production type: type: string enum: - preview - standard - prod description: >- Stage type. `standard` - regular deployment stage. `prod` - production stage. `preview` - ephemeral preview environment stage for pull request previews. example: standard order: type: integer minimum: 0 maximum: 50 description: >- Position of the stage in the pipeline, starting from 0. Lower numbers appear first. example: 1 branch: anyOf: - type: string - type: 'null' description: >- Git branch associated with this stage. Used to filter deployments by branch. example: main auto_create_app: type: boolean description: >- Whether to automatically create a preview app when a pull request is opened. Only applies to preview stages. example: false delete_stale_apps: type: boolean description: >- Whether to automatically delete preview apps that have not been deployed for longer than the stale app threshold. Only applies to preview stages. example: false stale_app_days: type: integer minimum: 1 maximum: 365 description: >- Number of days after the last deployment before a preview app is considered stale and eligible for automatic deletion. Only applies when delete_stale_apps is enabled. example: 5 created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: >- Timestamp when the stage was created, in ISO 8601 format example: '2025-01-30T00:00:00.000Z' updated_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: >- Timestamp when the stage was last modified, in ISO 8601 format example: '2025-01-30T00:00:00.000Z' required: - id - pipeline_id - display_name - type - order - branch - auto_create_app - delete_stale_apps - stale_app_days - created_at - updated_at additionalProperties: false description: Pipeline stages ordered by position created_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: >- Timestamp when the pipeline was created, in ISO 8601 format example: '2025-01-30T00:00:00.000Z' updated_at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: >- Timestamp when the pipeline was last modified, in ISO 8601 format example: '2025-01-30T00:00:00.000Z' required: - id - company_id - project_id - display_name - type - stages - created_at - updated_at additionalProperties: false '401': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Unauthorized status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 401 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '403': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Forbidden status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 403 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '404': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Not found status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 404 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false '500': description: Default Response content: application/json: schema: type: object properties: message: type: string description: Error message example: Internal Server Error status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: HTTP status code example: 500 data: type: object properties: code: description: Error tracking code for support reference example: err-abc-123 type: string message: description: Additional error details or instructions example: >- If you need assistance, please contact support and provide this error code. type: string additionalProperties: false required: - message - status additionalProperties: false components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- API key authentication. Pass your API key as a Bearer token in the Authorization header. ````