Skip to content

List Leads (Search)

POST https://api.prosperworks.com/developer_api/v1/leads/search

The /search endpoint provides the ability to list Leads and sort the results by certain parameters. When multiple criteria are

provided, records meeting ALL criteria will be returned (the filtering criteria have an 'AND' relationship).

Certain fields can be filtered by an empty value, i.e., filter records where the field is not specified. For Leads, these fields are: city, state, postal_code, tags, custom dropdown, custom multi-select fields.

For an example of how this works, see Search by Empty Field. Some fields (e.g. assignee_ids) can also filter for an empty value by specifying -2 as the ID.

To search by custom fields, see Search Entity by Custom Field in the Custom Fields section of the docs.

To change the number of records returned, change the "page_size" parameter. E.g., specify 200 for a page size of 200 records. Please note that search requests are limited to returning only the first 100,000 records regardless of the pagination parameters. If your search filter matches more than 100,000 records, we recommend modifying your search filter to separate your result set.

Field Type Details Default
page_number number The page number (starting with 1) that you would like to view. 1
page_size number The number of entries included in a page of results 20
sort_by string The field on which to sort the results (see footnote 1). name
sort_direction string The direction in which to sort the results. Possible values are: asc or desc. asc
name string Full name of the Lead to search for. none
phone_number string Phone number of the Lead to search for. none
emails string Email of the Lead to search for. none
assignee_ids number[] The ids of Users that Leads are assigned to (see footnote 2). none
status_ids number[] An array of Lead status IDs (see footnote 3). none
customer_source_ids number[] An array of customer source IDs (see footnote 4). none
city string The city in which Leads must be located. none
state string The state or province in which Leads must be located. none
postal_code string The postal code in which Leads must be located. none
country string The two character country code where Leads must be located. none
tags string[] Filter Leads to those that match at least one of the tags specified. none
followed number 1: followed, 2: not followed none
age number The maximum age in seconds that each Lead must be. none
minimum_monetary_value number The minimum monetary value Leads must have. none
maximum_monetary_value number The maximum monetary value Leads must have. none
minimum_interaction_count number The minimum number of interactions Leads must have had. none
maximum_interaction_count number The maximum number of interactions Leads must have had. none
minimum_interaction_date timestamp The Unix timestamp of the earliest date of the last interaction. none
maximum_interaction_date timestamp The Unix timestamp of the latest date of the last interaction. none
minimum_created_date timestamp The Unix timestamp of the earliest date Leads are created. none
maximum_created_date timestamp The Unix timestamp of the latest date Leads are created. none
minimum_modified_date timestamp The Unix timestamp of the earliest date Leads are modified. none
maximum_modified_date timestamp The Unix timestamp of the latest date Leads are modified. none
include_converted_leads boolean Specify if response should contain converted leads. false

Foonotes:

  1. Possible fields are: name, first_name, last_name, company_name, title, value, email, phone, date_modified, date_created, city, state, country, zip, inactive_days.
    • date_modified and date_created: sorting is from oldest to newest
    • inactive_days: sorting is from newest to oldest
  2. To get User IDs, see List Users in the Account and Users section of the docs. Enter -2 as an ID for no assignee.
  3. To get lead status IDs, see List Lead Statuses.
  4. To get customer source IDs, see List Customer Sources. Enter -2 as an ID for no customer source.

Request body

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

Example Requests

1
2
3
4
5
6
7
8
9
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 "{
  \"page_size\": 200,
  \"sort_by\": \"name\"
}"
  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
[
  {
    "id": 9150547,
    "name": "My Contact",
    "prefix": null,
    "first_name": "My",
    "last_name": "Contact",
    "middle_name": null,
    "suffix": null,
    "address": null,
    "assignee_id": null,
    "company_name": null,
    "customer_source_id": null,
    "details": null,
    "email": {
      "email": "mycontact@noemail.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_value": null,
    "socials": [],
    "status": "New",
    "status_id": 208231,
    "tags": [],
    "title": null,
    "websites": [],
    "phone_numbers": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": null
      },
      {
        "custom_field_definition_id": 103481,
        "value": null
      }
    ],
    "date_created": 1490045162,
    "date_modified": 1490045162,
    "date_last_contacted": 1490045162,
    "converted_opportunity_id": null,
    "converted_contact_id": null,
    "converted_at": null 
  },
  {
    "id": 9150552,
    "name": "My Contact",
    "prefix": null,
    "first_name": "My",
    "last_name": "Contact",
    "middle_name": null,
    "suffix": null,
    "address": null,
    "assignee_id": null,
    "company_name": null,
    "customer_source_id": null,
    "details": null,
    "email": null,
    "interaction_count": 0,
    "monetary_value": null,
    "socials": [],
    "status": "New",
    "status_id": 208231,
    "tags": [],
    "title": null,
    "websites": [],
    "phone_numbers": [
      {
        "number": "415-123-45678",
        "category": "mobile"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": null
      },
      {
        "custom_field_definition_id": 103481,
        "value": null
      }
    ],
    "date_created": 1490045237,
    "date_modified": 1490045237,
    "date_last_contacted": 1490045237,
    "converted_opportunity_id": null,
    "converted_contact_id": null,
    "converted_at": null 
  },
  {
    "id": 9150578,
    "name": "My Contact",
    "prefix": null,
    "first_name": "My",
    "last_name": "Contact",
    "middle_name": null,
    "suffix": null,
    "address": null,
    "assignee_id": null,
    "company_name": null,
    "customer_source_id": null,
    "details": null,
    "email": null,
    "interaction_count": 0,
    "monetary_value": null,
    "socials": [],
    "status": "New",
    "status_id": 208231,
    "tags": [],
    "title": null,
    "websites": [],
    "phone_numbers": [
      {
        "number": "415-123-45678",
        "category": "mobile"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 100764,
        "value": null
      },
      {
        "custom_field_definition_id": 103481,
        "value": null
      }
    ],
    "date_created": 1490045279,
    "date_modified": 1490045279,
    "date_last_contacted": 1490045279,
    "converted_opportunity_id": null,
    "converted_contact_id": null,
    "converted_at": null 
  }
]

List Leads in groups of 200

1
2
3
4
5
6
7
8
9
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 "{
  \"page_size\": 200,
  \"sort_by\": \"name\"
}"
  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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2501,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "blah"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      },
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 8,
        "value": null
      },
      {
        "custom_field_definition_id": 11,
        "value": null
      },
      {
        "custom_field_definition_id": 9,
        "value": null
      },
      {
        "custom_field_definition_id": 7,
        "value": false
      },
      {
        "custom_field_definition_id": 3,
        "value": null
      },
      {
        "custom_field_definition_id": 4,
        "value": null
      },
      {
        "custom_field_definition_id": 10,
        "value": null
      },
      {
        "custom_field_definition_id": 5,
        "value": null
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1516743967,
    "date_last_contacted": 1515796263
  },
  {
    "id": 5,
    "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": 4,
    "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": "USD",
    "monetary_value": 5000,
    "socials": [],
    "status": "Unqualified",
    "status_id": 7,
    "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": 8,
        "value": null
      },
      {
        "custom_field_definition_id": 11,
        "value": null
      },
      {
        "custom_field_definition_id": 9,
        "value": null
      },
      {
        "custom_field_definition_id": 7,
        "value": false
      },
      {
        "custom_field_definition_id": 3,
        "value": null
      },
      {
        "custom_field_definition_id": 4,
        "value": null
      },
      {
        "custom_field_definition_id": 12,
        "value": []
      },
      {
        "custom_field_definition_id": 10,
        "value": null
      },
      {
        "custom_field_definition_id": 6,
        "value": null
      },
      {
        "custom_field_definition_id": 5,
        "value": null
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1515795399,
    "date_last_contacted": null
  },
  {
    "id": 12,
    "name": "Test User",
    "prefix": null,
    "first_name": "Test",
    "last_name": "User",
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "123 Abc Rd",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94114",
      "country": ""
    },
    "assignee_id": 2,
    "company_name": null,
    "customer_source_id": null,
    "details": null,
    "email": null,
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": null,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [],
    "title": null,
    "websites": [],
    "phone_numbers": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 8,
        "value": null
      },
      {
        "custom_field_definition_id": 11,
        "value": null
      },
      {
        "custom_field_definition_id": 9,
        "value": null
      },
      {
        "custom_field_definition_id": 7,
        "value": false
      },
      {
        "custom_field_definition_id": 3,
        "value": null
      },
      {
        "custom_field_definition_id": 4,
        "value": null
      },
      {
        "custom_field_definition_id": 12,
        "value": []
      },
      {
        "custom_field_definition_id": 10,
        "value": null
      },
      {
        "custom_field_definition_id": 6,
        "value": null
      },
      {
        "custom_field_definition_id": 5,
        "value": null
      }
    ],
    "date_created": 1516671366,
    "date_modified": 1516671455,
    "date_last_contacted": null
  }
]

Search by Full Name

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"name\": \"Jim Halpert (sample2)\"
}"
  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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1515800495,
    "date_last_contacted": 1515796263
  },
  {
    "id": 5,
    "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": 4,
    "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": "USD",
    "monetary_value": 5000,
    "socials": [],
    "status": "Unqualified",
    "status_id": 7,
    "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": 12,
        "value": []
      },
      {
        "custom_field_definition_id": 6,
        "value": null
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1515795399,
    "date_last_contacted": null
  }
]

Search by Followed

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"followed\": 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515796276,
    "date_last_contacted": 1515796263
  }
]

Search by Assignee IDs

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"assignee_ids\": [2]
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "Unqualified",
    "status_id": 7,
    "tags": [],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515783705,
    "date_last_contacted": null
  }
]

Search by Interaction Count

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"minimum_interaction_count\": 1,
  \"maximum_interaction_count\": 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515796276,
    "date_last_contacted": 1515796263
  }
]

Search by City

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"city\": \"Philadelphia\"
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515795800,
    "date_last_contacted": null
  }
]

Search by State

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"state\": \"PA\"
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515795800,
    "date_last_contacted": null
  }
]

Search by Postal Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"postal_code\": \"18503\"
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515795800,
    "date_last_contacted": null
  }
]

Search by Country

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"country\": \"US\"
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515795800,
    "date_last_contacted": null
  }
]

Search by Customer Source IDs

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"customer_source_ids\": [4]
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515786833,
    "date_last_contacted": null
  },
  {
    "id": 5,
    "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": 4,
    "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": "Unqualified",
    "status_id": 7,
    "tags": [
      "sample"
    ],
    "title": "Office Coordinator",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5105553333",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515525131,
    "date_last_contacted": null
  }
]

Search by Email

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"emails\": \"jim@dundermifflin.com\"
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2501,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "blah"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1516214189,
    "date_last_contacted": 1515796263
  }
]

Search by Monetary Value

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"minimum_monetary_value\": 2500,
  \"maximum_monetary_value\": 2500
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515795399,
    "date_last_contacted": null
  }
]

Search by Phone Number

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"phone_number\": \"5104447778\"
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1515800495,
    "date_last_contacted": 1515796263
  }
]

Search by Status IDs

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"status_ids\": [7]
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 0,
    "monetary_unit": null,
    "monetary_value": 2500,
    "socials": [],
    "status": "Unqualified",
    "status_id": 7,
    "tags": [],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515783705,
    "date_last_contacted": null
  },
  {
    "id": 5,
    "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": 4,
    "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": "Unqualified",
    "status_id": 7,
    "tags": [
      "sample"
    ],
    "title": "Office Coordinator",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5105553333",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515525131,
    "date_last_contacted": null
  }
]

Search by Tags

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"tags\": { \"option\": \"ANY\", \"value\": [\"blah\"] }
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2501,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "blah"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1516214189,
    "date_last_contacted": 1515796263
  }
]

Search by Created Date

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"minimum_created_date\": 1515434000,
  \"maximum_created_date\": 1515435000
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515796276,
    "date_last_contacted": 1515796263
  },
  {
    "id": 5,
    "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": 4,
    "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": "USD",
    "monetary_value": 5000,
    "socials": [],
    "status": "Unqualified",
    "status_id": 7,
    "tags": [
      "sample"
    ],
    "title": "Office Coordinator",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5105553333",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515795399,
    "date_last_contacted": null
  }
]

Search by Modified Date

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"minimum_modified_date\": 1515796000,
  \"maximum_modified_date\": 1515797000
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515796276,
    "date_last_contacted": 1515796263
  }
]

Search by Interaction Date

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"minimum_interaction_date\": 1515796000,
  \"maximum_interaction_date\": 1515797000
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515796276,
    "date_last_contacted": 1515796263
  }
]

Search by Status Change Date

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"minimum_status_change_date\": 1515786000,
  \"maximum_status_change_date\": 1515787000
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [],
    "date_created": 1515434872,
    "date_modified": 1515796276,
    "date_last_contacted": 1515796263
  }
]

Search by Empty Field

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"city\": { \"allow_empty\": true, \"value\": \"Philadelphia\" }
}"
  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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2501,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "blah"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1516214189,
    "date_last_contacted": 1515796263
  },
  {
    "id": 5,
    "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": 4,
    "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": "USD",
    "monetary_value": 5000,
    "socials": [],
    "status": "Unqualified",
    "status_id": 7,
    "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": 12,
        "value": []
      },
      {
        "custom_field_definition_id": 6,
        "value": null
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1515795399,
    "date_last_contacted": null
  }
]

Search by Custom Multi-Select Dropdown

 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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"custom_fields\": [{
    \"custom_field_definition_id\": 12,
    \"value\": [8],
    \"option\": \"ANY\"
  }]
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1515800495,
    "date_last_contacted": 1515796263
  }
]

Search by Custom Multi-Select Dropdown Set to Empty

 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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"custom_fields\": [{
    \"custom_field_definition_id\": 12,
    \"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
[
  {
    "id": 5,
    "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": 4,
    "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": "USD",
    "monetary_value": 5000,
    "socials": [],
    "status": "Unqualified",
    "status_id": 7,
    "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": 12,
        "value": []
      },
      {
        "custom_field_definition_id": 6,
        "value": null
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1515795399,
    "date_last_contacted": null
  }
]

Search by 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 "{
  \"page_size\": 25,
  \"sort_by\": \"name\",
  \"custom_fields\": [{
    \"custom_field_definition_id\": 6,
    \"minimum_value\": 1515744000,
    \"maximum_value\": 1515745000
  }]
}"
 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
[
  {
    "id": 6,
    "name": "Jim Halpert (sample2)",
    "prefix": null,
    "first_name": "Jim Halpert (sample2)",
    "last_name": null,
    "middle_name": null,
    "suffix": null,
    "address": {
      "street": "213 West Main St",
      "city": "Philadelphia",
      "state": "PA",
      "postal_code": "18503",
      "country": "US"
    },
    "assignee_id": 2,
    "company_name": "Dunder Mifflin, Inc.",
    "customer_source_id": 4,
    "details": "This is an update",
    "email": {
      "email": "jim@dundermifflin.com",
      "category": "work"
    },
    "interaction_count": 1,
    "monetary_unit": "USD",
    "monetary_value": 2500,
    "socials": [],
    "status": "New",
    "status_id": 5,
    "tags": [
      "tag1"
    ],
    "title": "Manager",
    "websites": [
      {
        "url": "http://www.dundermifflin.com",
        "category": "work"
      }
    ],
    "phone_numbers": [
      {
        "number": "5104447778",
        "category": "work"
      }
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": []
      }
    ],
    "date_created": 1515434872,
    "date_modified": 1515800180,
    "date_last_contacted": 1515796263
  }
]