Skip to content

Search Entity (Leads, People, etc) by Custom Field

POST https://api.prosperworks.com/developer_api/v1/{{entity_name_in_plural}}/search

Custom fields are available for each of the entities (Leads, People, Companies, Opportunities, Projects, and Tasks). Custom field types include: Text Field, Text Area, Dropdown, Date, Checkbox, Number Field, URL, Percentage, Currency, and Multi-Select Dropdown. Text fields are not searchable at this point. The table below summarizes the behavior of each of these fields.

Field Type Search for Empty Value? Any, All, None Options
Dropdown integer array Yes No
Date integer range No No
Checkbox boolean No No
Number Field numeric No No
Percentage numeric range No No
Currency integer range No No
Multi-Select Dropdown integer array Yes Yes

Except for text-related fields, each custom field can be searched via the dev API search endpoint for any of the entities. For Leads, this would be the endpoint /leads/search.

Dropdown and Multi-Select Dropdown fields have the additional option of searching for records where dropdown and multi-select dropdown fields are empty. This can be accomplished by adding an additional field: { "allow_empty": true }. Searching by Multi-select dropdown also allows searching if any, all, or none of the dropdown options are to be searched. These options can be used together.

Examples of searching for each of the searchable fields can be found under the dropdown menu on the right. Examples given are for Leads and can be easily interchanged with any other entity.

Request Body

1
2
3
4
{
  "page_size": 25,
  "sort_by": "name"
}

Example Requests

Search Custom Date Field

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/leads/search" \
  --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" \
  --data "{
    \"custom_fields\": [
        {
            \"custom_field_definition_id\": 4,
            \"minimum_value\": 1518595200,
            \"maximum_value\": 1518596200
        }
    ]
}"
 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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
[
  {
    "id": 2,
    "name": "Jim Halpert (sample)",
    "prefix": null,
    "first_name": "Jim Halpert (sample)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18503",
      "country": null
    },
    "assignee_id": null,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 1,
    "details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 1,
    "tags": [
      "sample"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 1,
        "value": "Blah"
      },
      {
        "custom_field_definition_id": 2,
        "value": "blah blah blah"
      },
      {
        "custom_field_definition_id": 3,
        "value": 1
      },
      {
        "custom_field_definition_id": 4,
        "value": 1518595200
      },
      {
        "custom_field_definition_id": 5,
        "value": true
      },
      {
        "custom_field_definition_id": 6,
        "value": 42.0
      },
      {
        "custom_field_definition_id": 7,
        "value": "http://blah.com"
      },
      {
        "custom_field_definition_id": 8,
        "value": 50
      },
      {
        "custom_field_definition_id": 9,
        "value": 1000.0
      },
      {
        "custom_field_definition_id": 10,
        "value": [
          3
        ]
      }
    ],
    "date_created": 1518656437,
    "date_modified": 1518657195,
    "date_last_contacted": null
  }
]

Search Custom Percentage Field

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/leads/search" \
  --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" \
  --data "{
    \"custom_fields\": [
        {
            \"custom_field_definition_id\": 8,
            \"minimum_value\": 1,
            \"maximum_value\": 50
        }
    ]
}"
 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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
[
  {
    "id": 2,
    "name": "Jim Halpert (sample)",
    "prefix": null,
    "first_name": "Jim Halpert (sample)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18503",
      "country": null
    },
    "assignee_id": null,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 1,
    "details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 1,
    "tags": [
      "sample"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 1,
        "value": "Blah"
      },
      {
        "custom_field_definition_id": 2,
        "value": "blah blah blah"
      },
      {
        "custom_field_definition_id": 3,
        "value": 1
      },
      {
        "custom_field_definition_id": 4,
        "value": 1518595200
      },
      {
        "custom_field_definition_id": 5,
        "value": true
      },
      {
        "custom_field_definition_id": 6,
        "value": 42.0
      },
      {
        "custom_field_definition_id": 7,
        "value": "http://blah.com"
      },
      {
        "custom_field_definition_id": 8,
        "value": 50
      },
      {
        "custom_field_definition_id": 9,
        "value": 1000.0
      },
      {
        "custom_field_definition_id": 10,
        "value": [
          3
        ]
      }
    ],
    "date_created": 1518656437,
    "date_modified": 1518657195,
    "date_last_contacted": null
  }
]

Search Custom Multi-Select Dropdown Field

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/leads/search" \
  --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" \
  --data "{
    \"custom_fields\": [
        {
            \"custom_field_definition_id\": 10,
            \"value\": [3]
        }
    ]
}"
 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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
[
  {
    "id": 2,
    "name": "Jim Halpert (sample)",
    "prefix": null,
    "first_name": "Jim Halpert (sample)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18503",
      "country": null
    },
    "assignee_id": null,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 1,
    "details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 1,
    "tags": [
      "sample"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 1,
        "value": "Blah"
      },
      {
        "custom_field_definition_id": 2,
        "value": "blah blah blah"
      },
      {
        "custom_field_definition_id": 3,
        "value": 1
      },
      {
        "custom_field_definition_id": 4,
        "value": 1518595200
      },
      {
        "custom_field_definition_id": 5,
        "value": true
      },
      {
        "custom_field_definition_id": 6,
        "value": 42.0
      },
      {
        "custom_field_definition_id": 7,
        "value": "http://blah.com"
      },
      {
        "custom_field_definition_id": 8,
        "value": 50
      },
      {
        "custom_field_definition_id": 9,
        "value": 1000.0
      },
      {
        "custom_field_definition_id": 10,
        "value": [
          3
        ]
      }
    ],
    "date_created": 1518656437,
    "date_modified": 1518657195,
    "date_last_contacted": null
  }
]

Search Custom Dropdown Field

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/leads/search" \
  --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" \
  --data "{
    \"custom_fields\": [
        {
            \"custom_field_definition_id\": 3,
            \"value\": [1]
        }
    ]
}"
 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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
[
  {
    "id": 2,
    "name": "Jim Halpert (sample)",
    "prefix": null,
    "first_name": "Jim Halpert (sample)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18503",
      "country": null
    },
    "assignee_id": null,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 1,
    "details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 1,
    "tags": [
      "sample"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 1,
        "value": "Blah"
      },
      {
        "custom_field_definition_id": 2,
        "value": "blah blah blah"
      },
      {
        "custom_field_definition_id": 3,
        "value": 1
      },
      {
        "custom_field_definition_id": 4,
        "value": 1518595200
      },
      {
        "custom_field_definition_id": 5,
        "value": true
      },
      {
        "custom_field_definition_id": 6,
        "value": 42.0
      },
      {
        "custom_field_definition_id": 7,
        "value": "http://blah.com"
      },
      {
        "custom_field_definition_id": 8,
        "value": 50
      },
      {
        "custom_field_definition_id": 9,
        "value": 1000.0
      },
      {
        "custom_field_definition_id": 10,
        "value": [
          3
        ]
      }
    ],
    "date_created": 1518656437,
    "date_modified": 1518657195,
    "date_last_contacted": null
  }
]

Search Custom Currency Field

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/leads/search" \
  --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" \
  --data "{
    \"custom_fields\": [
        {
            \"custom_field_definition_id\": 9,
            \"minimum_value\": 500,
            \"maximum_value\": 2000
        }
    ]
}"
 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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
[
  {
    "id": 2,
    "name": "Jim Halpert (sample)",
    "prefix": null,
    "first_name": "Jim Halpert (sample)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18503",
      "country": null
    },
    "assignee_id": null,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 1,
    "details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 1,
    "tags": [
      "sample"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 1,
        "value": "Blah"
      },
      {
        "custom_field_definition_id": 2,
        "value": "blah blah blah"
      },
      {
        "custom_field_definition_id": 3,
        "value": 1
      },
      {
        "custom_field_definition_id": 4,
        "value": 1518595200
      },
      {
        "custom_field_definition_id": 5,
        "value": true
      },
      {
        "custom_field_definition_id": 6,
        "value": 42.0
      },
      {
        "custom_field_definition_id": 7,
        "value": "http://blah.com"
      },
      {
        "custom_field_definition_id": 8,
        "value": 50
      },
      {
        "custom_field_definition_id": 9,
        "value": 1000.0
      },
      {
        "custom_field_definition_id": 10,
        "value": [
          3
        ]
      }
    ],
    "date_created": 1518656437,
    "date_modified": 1518657195,
    "date_last_contacted": null
  }
]

Search Custom Dropdown Field for Empty Value

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/leads/search" \
  --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" \
  --data "{
    \"custom_fields\": [
        {
            \"custom_field_definition_id\": 3,
            \"allow_empty\": true
        }
    ]
}"
 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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
[
  {
    "id": 1,
    "name": "Pam Beesly (sample)",
    "prefix": null,
    "first_name": "Pam Beesly (sample)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": null,
    "assignee_id": null,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 1,
    "details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
    "email": {
      "email": "pam@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 5000,
    "socials": [],
    "status": "New",
    "status_id": 1,
    "tags": [
      "sample"
    ],
    "title": "Office Coordinator",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5105553333",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 1,
        "value": null
      },
      {
        "custom_field_definition_id": 9,
        "value": null
      },
      {
        "custom_field_definition_id": 4,
        "value": null
      },
      {
        "custom_field_definition_id": 6,
        "value": null
      },
      {
        "custom_field_definition_id": 10,
        "value": []
      },
      {
        "custom_field_definition_id": 2,
        "value": null
      },
      {
        "custom_field_definition_id": 8,
        "value": null
      },
      {
        "custom_field_definition_id": 7,
        "value": null
      },
      {
        "custom_field_definition_id": 5,
        "value": false
      },
      {
        "custom_field_definition_id": 3,
        "value": null
      }
    ],
    "date_created": 1518656436,
    "date_modified": 1518656436,
    "date_last_contacted": null
  }
]

Search Custom Multi-Select Dropdown Field for Both Set Value and Empty Value

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/leads/search" \
  --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" \
  --data "{
    \"custom_fields\": [
        {
            \"custom_field_definition_id\": 10,
            \"value\": [3],
            \"allow_empty\": true
        }
    ]
}"
  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
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
[
  {
    "id": 2,
    "name": "Jim Halpert (sample)",
    "prefix": null,
    "first_name": "Jim Halpert (sample)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18503",
      "country": null
    },
    "assignee_id": null,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 1,
    "details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 1,
    "tags": [
      "sample"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 1,
        "value": "Blah"
      },
      {
        "custom_field_definition_id": 2,
        "value": "blah blah blah"
      },
      {
        "custom_field_definition_id": 3,
        "value": 1
      },
      {
        "custom_field_definition_id": 4,
        "value": 1518595200
      },
      {
        "custom_field_definition_id": 5,
        "value": true
      },
      {
        "custom_field_definition_id": 6,
        "value": 42.0
      },
      {
        "custom_field_definition_id": 7,
        "value": "http://blah.com"
      },
      {
        "custom_field_definition_id": 8,
        "value": 50
      },
      {
        "custom_field_definition_id": 9,
        "value": 1000.0
      },
      {
        "custom_field_definition_id": 10,
        "value": [
          3
        ]
      }
    ],
    "date_created": 1518656437,
    "date_modified": 1518657195,
    "date_last_contacted": null
  },
  {
    "id": 1,
    "name": "Pam Beesly (sample)",
    "prefix": null,
    "first_name": "Pam Beesly (sample)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": null,
    "assignee_id": null,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 1,
    "details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
    "email": {
      "email": "pam@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 5000,
    "socials": [],
    "status": "New",
    "status_id": 1,
    "tags": [
      "sample"
    ],
    "title": "Office Coordinator",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5105553333",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 1,
        "value": null
      },
      {
        "custom_field_definition_id": 9,
        "value": null
      },
      {
        "custom_field_definition_id": 4,
        "value": null
      },
      {
        "custom_field_definition_id": 6,
        "value": null
      },
      {
        "custom_field_definition_id": 10,
        "value": []
      },
      {
        "custom_field_definition_id": 2,
        "value": null
      },
      {
        "custom_field_definition_id": 8,
        "value": null
      },
      {
        "custom_field_definition_id": 7,
        "value": null
      },
      {
        "custom_field_definition_id": 5,
        "value": false
      },
      {
        "custom_field_definition_id": 3,
        "value": null
      }
    ],
    "date_created": 1518656436,
    "date_modified": 1518656436,
    "date_last_contacted": null
  }
]

Search Custom Number Field

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/leads/search" \
  --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" \
  --data "{
    \"custom_fields\": [
        {
            \"custom_field_definition_id\": 6,
            \"minimum_value\": 40,
            \"maximum_value\": 50
        }
    ]
}"
 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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
[
  {
    "id": 2,
    "name": "Jim Halpert (sample)",
    "prefix": null,
    "first_name": "Jim Halpert (sample)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18503",
      "country": null
    },
    "assignee_id": null,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 1,
    "details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 1,
    "tags": [
      "sample"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 1,
        "value": "Blah"
      },
      {
        "custom_field_definition_id": 2,
        "value": "blah blah blah"
      },
      {
        "custom_field_definition_id": 3,
        "value": 1
      },
      {
        "custom_field_definition_id": 4,
        "value": 1518595200
      },
      {
        "custom_field_definition_id": 5,
        "value": true
      },
      {
        "custom_field_definition_id": 6,
        "value": 42.0
      },
      {
        "custom_field_definition_id": 7,
        "value": "http://blah.com"
      },
      {
        "custom_field_definition_id": 8,
        "value": 50
      },
      {
        "custom_field_definition_id": 9,
        "value": 1000.0
      },
      {
        "custom_field_definition_id": 10,
        "value": [
          3
        ]
      }
    ],
    "date_created": 1518656437,
    "date_modified": 1518657195,
    "date_last_contacted": null
  }
]

Search Custom Checkbox Field

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/leads/search" \
  --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" \
  --data "{
    \"custom_fields\": [
        {
            \"custom_field_definition_id\": 5,
            \"value\": true
        }
    ]
}"
 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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
[
  {
    "id": 2,
    "name": "Jim Halpert (sample)",
    "prefix": null,
    "first_name": "Jim Halpert (sample)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Scranton",
      "state": "PA",
      "postal_code": "18503",
      "country": null
    },
    "assignee_id": null,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 1,
    "details": "A Lead is someone you've qualified as a potential client. When you are ready to start making a deal, simply convert the Lead into an Opportunity.\n\nOnce your Lead becomes an Opportunity, you'll be able to track progress between each stage of the deal making process in your fully customizable Opportunity Pipeline. Add your own Lead and convert it to an Opportunity to see how it works!",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 1,
    "tags": [
      "sample"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 1,
        "value": "Blah"
      },
      {
        "custom_field_definition_id": 2,
        "value": "blah blah blah"
      },
      {
        "custom_field_definition_id": 3,
        "value": 1
      },
      {
        "custom_field_definition_id": 4,
        "value": 1518595200
      },
      {
        "custom_field_definition_id": 5,
        "value": true
      },
      {
        "custom_field_definition_id": 6,
        "value": 42.0
      },
      {
        "custom_field_definition_id": 7,
        "value": "http://blah.com"
      },
      {
        "custom_field_definition_id": 8,
        "value": 50
      },
      {
        "custom_field_definition_id": 9,
        "value": 1000.0
      },
      {
        "custom_field_definition_id": 10,
        "value": [
          3
        ]
      }
    ],
    "date_created": 1518656437,
    "date_modified": 1518657195,
    "date_last_contacted": null
  }
]