Skip to main content
GET
/
pipeline-runs
List pipeline runs
curl --request GET \
  --url https://api.sftpsync.io/pipeline-runs \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "run_123",
      "status": "completed"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1,
    "totalPages": 1
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
page
integer
Required range: x >= 1
​
limit
integer
Required range: 1 <= x <= 1000
​
clientId
string
​
pipelineId
string
​
status
enum<string>
Available options:
pending,
processing,
completed,
delivered,
failed,
acknowledged
​
model
string
​
connectionName
string

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

​
clientName
string
deprecated

Deprecated: use connectionName.

​
pipelineName
string

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

​
id
string[]

Response

Paginated pipeline runs

​
data
object[]
required
​
pagination
object
required