List Stages

GET

/leads/stages

GET

/leads/stages

1 curl -G https://https//https/leads/stages \
2      -H "{{tenant_key_name}}: {{tenant_key_value1}}|{{tenant_key_value2}}" \
3      -H "Content-Type: application/json" \
4      -d is_open=true \
5      -d sort_order=1 \
6      -d page=1 \
7      -d per_page=15

200Retrieved

1 {
2   "stages": [
3     {
4       "id": "stage_001",
5       "name": "New Lead",
6       "is_open": true,
7       "sort_order": 1
8     },
9     {
10       "id": "stage_002",
11       "name": "Contacted",
12       "is_open": true,
13       "sort_order": 2
14     },
15     {
16       "id": "stage_003",
17       "name": "Qualified",
18       "is_open": true,
19       "sort_order": 3
20     },
21     {
22       "id": "stage_004",
23       "name": "Proposal Sent",
24       "is_open": true,
25       "sort_order": 4
26     },
27     {
28       "id": "stage_005",
29       "name": "Negotiation",
30       "is_open": true,
31       "sort_order": 5
32     },
33     {
34       "id": "stage_006",
35       "name": "Closed Won",
36       "is_open": false,
37       "sort_order": 6
38     },
39     {
40       "id": "stage_007",
41       "name": "Closed Lost",
42       "is_open": false,
43       "sort_order": 7
44     }
45   ],
46   "page": 1,
47   "per_page": 15,
48   "total": 7
49 }

List Lead stages for the current tenant + tenant_location.

Query params: is_open (bool), sort_order (int), page, per_page (1-100, default 15).

Query parameters

is_openstringOptional

Optional: true|false - only non-terminal stages

sort_orderstringOptional

Optional: Integer ≥ 0

pageintegerOptional

Optional: Page number

per_pageintegerOptional

Optional: Results per page (default 15, max 100)

Response

Successful response

Headers

Query parameters

Response