Skip to content

Fetch a Custom Field Definition

GET https://api.prosperworks.com/developer_api/v1/custom_field_definitions/{{custom_field_definition_id}}

Example Requests

Custom Field Definitioin

1
2
3
4
5
curl --request GET "https://api.prosperworks.com/developer_api/v1/custom_field_definitions/126240" \
  --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
27
28
29
30
31
32
33
34
35
36
{
  "id": 126240,
  "name": "Color option",
  "data_type": "Dropdown",
  "available_on": [
    "opportunity",
    "project"
  ],
  "options": [
    {
      "id": 167776,
      "name": "Yellow",
      "rank": 4
    },
    {
      "id": 167775,
      "name": "Orange",
      "rank": 3
    },
    {
      "id": 167774,
      "name": "Blue",
      "rank": 2
    },
    {
      "id": 167773,
      "name": "Green",
      "rank": 1
    },
    {
      "id": 167772,
      "name": "Red",
      "rank": 0
    }
  ]
}