Skip to main content
GET
/
api
/
pipelines
/
{pipelineId}
/
usage
Check pipeline usage and deletion alternatives
curl --request GET \
  --url https://your-instance.example.com/api/pipelines/{pipelineId}/usage \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "pipelineId": "66f0a0b0c0d0e0f0a0b0c0d0",
  "pipelineName": "Sales pipeline",
  "pipelineType": "Contact",
  "isInUse": true,
  "recordsCount": 22,
  "hasAlternatives": true,
  "alternatives": [
    {
      "id": "66f0a0b0c0d0e0f0a0b0c0d1",
      "name": "EMEA sales pipeline"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.tetherai.ca/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

pipelineId
string
required

Response

Pipeline usage returned

success
boolean
pipelineId
string
pipelineName
string
pipelineType
enum<string>
Available options:
Contact,
Application
isInUse
boolean
recordsCount
number
hasAlternatives
boolean
alternatives
object[]