Skip to main content
GET
/
pipelines
List pipelines
curl --request GET \
  --url https://api.sftpsync.io/pipelines \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "mappings": [
      {
        "sourceField": "<string>",
        "targetField": "<string>",
        "transform": "<string>",
        "defaultValue": "<any>"
      }
    ],
    "isActive": true,
    "workspaceId": "<string>",
    "clientId": "<string>",
    "schemaId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
clientId
string

Filter by client ID.

​
clientName
string

Filter by client name (partial, case-insensitive).

Response

200 - application/json

Pipelines

​
id
string
required
​
name
string
required
​
mappings
required
​
isActive
boolean
required
​
workspaceId
string
required
​
clientId
string
required
​
schemaId
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required