List pipelines

GET/api/v1/pipelines

scope deals:read

Every pipeline on the account with its stages in order. Use the stage ids to create and move deals.

Request

curl "https://your-crm.example.com/api/v1/pipelines" \
  -H "Authorization: Bearer $RAABTA_API_KEY"

Response · 200 OK

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "name": "Sales Pipeline",
      "stages": [
        {
          "id": "b2c3d4e5-f6a7-4b8c-9d0e-1f2a3b4c5d6e",
          "name": "New lead",
          "position": 0,
          "color": "#3b82f6"
        },
        {
          "id": "c3d4e5f6-a7b8-4c9d-8e1f-2a3b4c5d6e7f",
          "name": "Qualified",
          "position": 1,
          "color": "#8b5cf6"
        },
        {
          "id": "d4e5f6a7-b8c9-4d0e-9f2a-3b4c5d6e7f8a",
          "name": "Proposal",
          "position": 2,
          "color": "#f59e0b"
        }
      ],
      "created_at": "2026-08-01T09:00:00.000Z"
    }
  ]
}

Response

Wrapped in { data: … }

Name	Type	Description
`id`required	`string (uuid)`	UUID
`name`required	`string`	Pipeline name
`stages`required	`object[]`	In position order
`stages[].id`required	`string (uuid)`	UUID
`stages[].name`required	`string`	Stage name
`stages[].position`required	`integer`	0-based order in the pipeline
`stages[].color`required	`string`	Hex colour chosen in the dashboard
`created_at`required	`string (date-time)`	ISO 8601 timestamp

Errors

Status	Code	When
401	`unauthorized`	No usable API key: the Authorization header is missing or malformed, or the key is unknown, revoked or expired. The three are deliberately indistinguishable.
403	`forbidden`	The key is valid but lacks the scope this endpoint requires, or the request came from an address outside the key’s IP allowlist. The message says which.
403	`account_suspended`	The account this key belongs to is suspended. Rotating the key will not help; contact support.
429	`rate_limited`	The per-key budget, or the per-IP budget for failed authentication, is exhausted. Honour `Retry-After` before retrying.
500	`internal`	Something failed on our side. Safe to retry with the same Idempotency-Key; quote `request_id` if it persists.