Read a pipeline
Returns a pipeline with all its actions, in order.
Last updated:
Returns a pipeline with all its actions, in order.
GET /api/v1/pipelines/{pipelineId}
Authorization
Requires a signed-in person with this scope: pipelines:read.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
X-Workspace-Id | header | yes | string (uuid) | The workspace the call acts in. Take it from the workspace list. |
pipelineId | path | yes | string (uuid) | The pipeline's id. |
Responses
200
The pipeline.
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | yes | |
name | string | yes | |
description | string | yes | |
status | one of DRAFT, VALID, INVALID | yes | |
statusReason | string | no | |
schedule | string | yes | |
createdBy | string | yes | |
createdAt | string (date-time) | yes | |
updatedAt | string (date-time) | yes | |
actions | list of object | yes | |
actions[].id | string (uuid) | yes | |
actions[].type | one of COPY, DELETE, TRANSFORM, SCRIPT, EXPORT, IMPORT | yes | |
actions[].writeStrategy | one of INSERT, MERGE, CLEAN | no | |
actions[].sequenceIndex | integer | yes | |
actions[].sourceEnvironmentId | string (uuid) | no | |
actions[].targetEnvironmentId | string (uuid) | yes | |
actions[].status | one of VALID, INCOMPLETE, INVALID | yes | |
actions[].entitySelections | list of object | yes | |
actions[].entitySelections[].selectionId | string | no | |
actions[].entitySelections[].entityIdentifier | string | no | |
actions[].entitySelections[].entityName | string | no | |
actions[].entitySelections[].entityDisplayName | string | no | |
actions[].entitySelections[].filterExpression | string | no | |
actions[].entitySelections[].transformations | list of object | no | |
actions[].entitySelections[].transformations[].fieldIdentifier | string | no | |
actions[].entitySelections[].transformations[].fieldName | string | no | |
actions[].entitySelections[].transformations[].fieldType | string | no | |
actions[].entitySelections[].transformations[].type | string | no | |
actions[].entitySelections[].transformations[].parameters | object | no | |
actions[].entitySelections[].transformations[].orderIndex | integer | no | |
actions[].entitySelections[].keyAttributes | list of string | no | |
actions[].entitySelections[].writeStrategy | one of INSERT, MERGE, CLEAN | no | |
actions[].entitySelections[].moduleIdentifier | string | no | |
actions[].entitySelections[].moduleName | string | no | |
actions[].entitySelections[].fields | list of object | no | |
actions[].entitySelections[].fields[].identifier | string | no | |
actions[].entitySelections[].fields[].name | string | no | |
actions[].entitySelections[].fields[].type | string | no | |
actions[].entitySelections[].fields[].typeDescriptor | string | no | |
actions[].config | object | yes | |
actions[].connectorName | string | no | Display name of the workspace connector an Export writes through, beside its id in config. Null when the action references no connector or that connector was deleted. |
Example response:
{
"id": "3a1b2c3d-4e5f-6071-8293-a4b5c6d7e8f9",
"name": "Nightly customer sync",
"description": "Copies customer records from Production to Staging every night.",
"status": "VALID",
"schedule": "0 2 * * *",
"createdBy": "alex.morgan@example.com",
"createdAt": "2026-10-12T09:00:00Z",
"updatedAt": "2026-10-12T09:05:00Z",
"actions": [
{
"id": "4b2c3d4e-5f60-7182-93a4-b5c6d7e8f9a0",
"type": "COPY",
"writeStrategy": "MERGE",
"sequenceIndex": 0,
"sourceEnvironmentId": "2f8b1c6a-9d3e-4f5a-8b7c-1e2d3f4a5b6c",
"targetEnvironmentId": "5c3d4e5f-6071-8293-a4b5-c6d7e8f9a0b1",
"status": "VALID",
"entitySelections": [],
"config": {}
}
]
}400
A path id is not even syntactically a valid id (not a well-formed UUID) — distinct from 404, which means a well-formed id that simply does not exist.
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | |
status | integer | yes | |
errorCode | string | yes | |
timestamp | string (date-time) | no | |
path | string | no | |
details | object | no |
403
The pipeline references an environment the caller cannot see.
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | |
status | integer | yes | |
errorCode | string | yes | |
timestamp | string (date-time) | no | |
path | string | no | |
details | object | no |
404
There is no such pipeline.
| Field | Type | Required | Description |
|---|---|---|---|
message | string | yes | |
status | integer | yes | |
errorCode | string | yes | |
timestamp | string (date-time) | no | |
path | string | no | |
details | object | no |