Create a pipeline
curl --request POST \
--url https://n-api.leadstaker.com/v1/pipelines \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"appearanceConfig": {
"card": {
"topLeft": {
"customFieldId": "<string>"
},
"topRight": {
"customFieldId": "<string>"
},
"primaryTitle": {
"customFieldId": "<string>"
},
"primaryValue": {
"customFieldId": "<string>"
},
"middleLeft": {
"customFieldId": "<string>"
},
"middleRight": {
"customFieldId": "<string>"
},
"bottomLeft": {
"customFieldId": "<string>"
},
"bottomRight": {
"customFieldId": "<string>"
},
"showTags": true
}
}
}
'import requests
url = "https://n-api.leadstaker.com/v1/pipelines"
payload = {
"name": "<string>",
"appearanceConfig": { "card": {
"topLeft": { "customFieldId": "<string>" },
"topRight": { "customFieldId": "<string>" },
"primaryTitle": { "customFieldId": "<string>" },
"primaryValue": { "customFieldId": "<string>" },
"middleLeft": { "customFieldId": "<string>" },
"middleRight": { "customFieldId": "<string>" },
"bottomLeft": { "customFieldId": "<string>" },
"bottomRight": { "customFieldId": "<string>" },
"showTags": True
} }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
appearanceConfig: {
card: {
topLeft: {customFieldId: '<string>'},
topRight: {customFieldId: '<string>'},
primaryTitle: {customFieldId: '<string>'},
primaryValue: {customFieldId: '<string>'},
middleLeft: {customFieldId: '<string>'},
middleRight: {customFieldId: '<string>'},
bottomLeft: {customFieldId: '<string>'},
bottomRight: {customFieldId: '<string>'},
showTags: true
}
}
})
};
fetch('https://n-api.leadstaker.com/v1/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://n-api.leadstaker.com/v1/pipelines",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'appearanceConfig' => [
'card' => [
'topLeft' => [
'customFieldId' => '<string>'
],
'topRight' => [
'customFieldId' => '<string>'
],
'primaryTitle' => [
'customFieldId' => '<string>'
],
'primaryValue' => [
'customFieldId' => '<string>'
],
'middleLeft' => [
'customFieldId' => '<string>'
],
'middleRight' => [
'customFieldId' => '<string>'
],
'bottomLeft' => [
'customFieldId' => '<string>'
],
'bottomRight' => [
'customFieldId' => '<string>'
],
'showTags' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://n-api.leadstaker.com/v1/pipelines"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"appearanceConfig\": {\n \"card\": {\n \"topLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"topRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryTitle\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryValue\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"showTags\": true\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://n-api.leadstaker.com/v1/pipelines")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"appearanceConfig\": {\n \"card\": {\n \"topLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"topRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryTitle\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryValue\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"showTags\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://n-api.leadstaker.com/v1/pipelines")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"appearanceConfig\": {\n \"card\": {\n \"topLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"topRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryTitle\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryValue\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"showTags\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "670fa8b21d94cc0010e3c7a5",
"name": "Vendas",
"projectId": "665f1c2e8a94b70012d4e9a1",
"sort": "CREATED_AT_DESC",
"createdAt": "2026-01-12T14:08:00.000Z",
"updatedAt": "2026-01-15T09:32:00.000Z"
}{
"errorCode": "<string>",
"message": "<string>",
"status": 123,
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"status": 123,
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}Pipelines
Create a pipeline
Creates the pipeline in the project of the API key and answers 201 with the created record.
POST
/
v1
/
pipelines
Create a pipeline
curl --request POST \
--url https://n-api.leadstaker.com/v1/pipelines \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"appearanceConfig": {
"card": {
"topLeft": {
"customFieldId": "<string>"
},
"topRight": {
"customFieldId": "<string>"
},
"primaryTitle": {
"customFieldId": "<string>"
},
"primaryValue": {
"customFieldId": "<string>"
},
"middleLeft": {
"customFieldId": "<string>"
},
"middleRight": {
"customFieldId": "<string>"
},
"bottomLeft": {
"customFieldId": "<string>"
},
"bottomRight": {
"customFieldId": "<string>"
},
"showTags": true
}
}
}
'import requests
url = "https://n-api.leadstaker.com/v1/pipelines"
payload = {
"name": "<string>",
"appearanceConfig": { "card": {
"topLeft": { "customFieldId": "<string>" },
"topRight": { "customFieldId": "<string>" },
"primaryTitle": { "customFieldId": "<string>" },
"primaryValue": { "customFieldId": "<string>" },
"middleLeft": { "customFieldId": "<string>" },
"middleRight": { "customFieldId": "<string>" },
"bottomLeft": { "customFieldId": "<string>" },
"bottomRight": { "customFieldId": "<string>" },
"showTags": True
} }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
appearanceConfig: {
card: {
topLeft: {customFieldId: '<string>'},
topRight: {customFieldId: '<string>'},
primaryTitle: {customFieldId: '<string>'},
primaryValue: {customFieldId: '<string>'},
middleLeft: {customFieldId: '<string>'},
middleRight: {customFieldId: '<string>'},
bottomLeft: {customFieldId: '<string>'},
bottomRight: {customFieldId: '<string>'},
showTags: true
}
}
})
};
fetch('https://n-api.leadstaker.com/v1/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://n-api.leadstaker.com/v1/pipelines",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'appearanceConfig' => [
'card' => [
'topLeft' => [
'customFieldId' => '<string>'
],
'topRight' => [
'customFieldId' => '<string>'
],
'primaryTitle' => [
'customFieldId' => '<string>'
],
'primaryValue' => [
'customFieldId' => '<string>'
],
'middleLeft' => [
'customFieldId' => '<string>'
],
'middleRight' => [
'customFieldId' => '<string>'
],
'bottomLeft' => [
'customFieldId' => '<string>'
],
'bottomRight' => [
'customFieldId' => '<string>'
],
'showTags' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://n-api.leadstaker.com/v1/pipelines"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"appearanceConfig\": {\n \"card\": {\n \"topLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"topRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryTitle\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryValue\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"showTags\": true\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://n-api.leadstaker.com/v1/pipelines")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"appearanceConfig\": {\n \"card\": {\n \"topLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"topRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryTitle\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryValue\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"showTags\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://n-api.leadstaker.com/v1/pipelines")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"appearanceConfig\": {\n \"card\": {\n \"topLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"topRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryTitle\": {\n \"customFieldId\": \"<string>\"\n },\n \"primaryValue\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"middleRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomLeft\": {\n \"customFieldId\": \"<string>\"\n },\n \"bottomRight\": {\n \"customFieldId\": \"<string>\"\n },\n \"showTags\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "670fa8b21d94cc0010e3c7a5",
"name": "Vendas",
"projectId": "665f1c2e8a94b70012d4e9a1",
"sort": "CREATED_AT_DESC",
"createdAt": "2026-01-12T14:08:00.000Z",
"updatedAt": "2026-01-15T09:32:00.000Z"
}{
"errorCode": "<string>",
"message": "<string>",
"status": 123,
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}{
"errorCode": "<string>",
"message": "<string>",
"status": 123,
"errors": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}Authorizations
Body
application/json
Response
Success
Minimum string length:
1Minimum string length:
1Available options:
CREATED_AT_ASC, CREATED_AT_DESC Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I