Skip to main content
GET
/
pipelines
/
{id}
Get a pipeline
curl --request GET \
  --url https://api.heffl.com/api/v1/pipelines/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "stages": [
    {
      "id": 123,
      "name": "<string>",
      "position": 123,
      "probability": 123
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
number
required

Pipeline ID

Response

200 - application/json

OK

id
number
required
name
string
required
stages
object[]
required