Skip to main content
GET
/
pipelines
List pipelines
curl --request GET \
  --url https://api.sftpsync.io/pipelines \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.sftpsync.io/pipelines"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sftpsync.io/pipelines', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sftpsync.io/pipelines",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.sftpsync.io/pipelines"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.sftpsync.io/pipelines")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.sftpsync.io/pipelines")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "<string>",
    "name": "<string>",
    "mappings": {
      "fieldMappings": [
        {
          "target": "<string>",
          "source": "<string>",
          "transform": "<string>",
          "value": "<string>",
          "sources": [
            "<string>"
          ],
          "delimiter": " "
        }
      ],
      "options": {},
      "validations": {}
    },
    "isActive": true,
    "clientId": "<string>",
    "schemaId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "direction": "inbound",
    "webhooks": [
      {
        "id": "<string>",
        "name": "<string>",
        "url": "<string>"
      }
    ]
  }
]

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.