Skip to content

List Lead Statuses

GET https://api.prosperworks.com/developer_api/v1/lead_statuses

Lead statuses are values that can be assigned to a Lead entity to indicate where they are in the qualification process.

Field Description
id (number) Unique identifier for the status
name (string) The name of the lead status
order (number) The position of the value in the list when displayed in the app
is_default (boolean) Indicates whether this value is selected as default when creating a new record

Example Requests

Lead Statuses

1
2
3
4
5
curl --location --request GET "https://api.prosperworks.com/developer_api/v1/lead_statuses" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
[
  {
    "id": 208231,
    "name": "New",
    "order": 1,
    "is_default": true
  },
  {
    "id": 208232,
    "name": "Open",
    "order": 2,
    "is_default": false
  },
  {
    "id": 208233,
    "name": "Unqualified",
    "order": 3,
    "is_default": false
  },
  {
    "id": 208234,
    "name": "Junk",
    "order": 4,
    "is_default": false
  }
]