Pipelines

Pipelines define the status stages for contacts and applications. Each organization has a single active pipeline per type that controls stage names, ordering, and colors.

GET/api/pipelines

Get the pipeline for your org

Fetch the active pipeline for the caller's organization. Use the type query param to switch between contact and application pipelines.

Query parameters

Name
type
Type
string
Description
Contact (default) or Application.

Request

GET

/api/pipelines?type=Contact

curl "https://your-tether-instance.com/api/pipelines?type=Contact" \
  -H "Authorization: Bearer {token}"

POST/api/pipelines

Create or update a pipeline

Upsert the pipeline for the organization. When you rename a stage via oldStage → newStage, contacts in the old status are migrated to the new name.

Body fields

Name
name
Type
string
Description
Pipeline name.
Name
description
Type
string
Description
Optional description.
Name
stages
Type
array
Description
Array of { oldStage?, newStage, color } objects.

Query parameters

Name
type
Type
string
Description
Contact (default) or Application.

Request

POST

/api/pipelines?type=Contact

curl -X POST "https://your-tether-instance.com/api/pipelines?type=Contact" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Revamp Contact Pipeline",
    "description": "Standard lead flow",
    "stages": [
      { "oldStage": "new_lead", "newStage": "new_lead", "color": "#2563eb" },
      { "newStage": "working", "color": "#22c55e" },
      { "newStage": "won", "color": "#d97706" }
    ]
  }'