Skip to main content
GET
List pipelines

Authorizations

x-api-key
string
header
required

Query Parameters

clientId
string

Filter by client ID.

connectionName
string

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

clientName
string
deprecated

Deprecated: use connectionName.

Response

200 - application/json

Pipelines

id
string
required
name
string
required
mappings
object
required

The mapping definition the API expects. Field mappings live under fieldMappings; not a bare array.

isActive
boolean
required
clientId
string
required

Connection id this pipeline is bound to.

schemaId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
direction
enum<string>
default:inbound

Pipeline direction. Outbound pipelines accept data via the Outbound Uploads API.

Available options:
inbound,
outbound
webhooks
object[]

Webhooks linked to this pipeline. Present and non-empty only when the pipeline has associated webhooks.