Get a location’s pipeline

The sales pipeline and its ordered stages. Read this before creating or moving a deal — the stage ids here are the only ones those endpoints accept. A location that has never used the pipeline gets the default one created on first read, so this never comes back empty.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

deals:read

Query Parameters

Name	Type	Required	Description
`locationId`	string	Required	Whose pipeline to read.

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/pipelines" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Pipeline retrieved successfully!",
  "content": {
    "pipeline": {
      "id": "pip_01",
      "name": "New Business",
      "isDefault": true,
      "stages": [
        {
          "id": "stg_01",
          "name": "Qualifying",
          "order": 0,
          "defaultProbability": 20
        },
        {
          "id": "stg_02",
          "name": "Proposal",
          "order": 1,
          "defaultProbability": 60
        }
      ]
    }
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

xRM → Pipeline

/xrm/pipeline