Skip to content

List Tasks (Search)

POST https://api.copper.com/developer_api/v1/tasks/search

The /search endpoint provides the ability to list people 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 Tasks, these fields are: company, opportunity, city, state, postal_code, tags, custom dropdown, custom multi-select fields. 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.

Note that this endpoint is eligible to return computed custom field values, click here for more information.

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
ids identifier[] An array of Task IDs. none
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). due_date
sort_direction string The direction in which to sort the results. Possible values are: asc or desc. asc
assignee_ids identifier[] The ids of Users that Tasks must be owned by, or -2 for Tasks with no owner. none
opportunity_ids identifier[] An array of Opportunity IDs (see footnote 2). none
project_ids identifier[] The ids of Projects that Tasks belong to, or -2 for Tasks with no project. none
statuses string[] Filter Tasks to statuses specified ("Open", "Completed"). none
tags string[] Filter Tasks to those that match at least one of the tags specified. none
followed number 1: followed, 2: not followed none
minimum_due_date timestamp The minimum due date Tasks must have. none
maximum_due_date timestamp The maximum due date Tasks must have. none
minimum_created_date timestamp The Unix timestamp of the earliest date Tasks are created. none
maximum_created_date timestamp The Unix timestamp of the latest date Tasks are created. none
minimum_modified_date timestamp The minimum modified date Tasks must have. none
maximum_modified_date timestamp The maximum modified date Tasks must have. none

Footnote:

  1. Possible fields are: name, assigned_to, related_to, status, priority, due_date, reminder_date, completed_date, date_created, date_modified.
  2. See List Opportunities (Search).

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.copper.com/developer_api/v1/tasks/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\"
}"

 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
[
  {
    "id": 3726701,
    "name": "Demo Task",
    "related_resource": {
      "id": null,
      "type": null
    },
    "assignee_id": 137658,
    "due_date": null,
    "reminder_date": null,
    "completed_date": null,
    "priority": "None",
    "status": "Open",
    "details": null,
    "tags": [],
    "custom_fields": [],
    "date_created": 1496771985,
    "date_modified": 1496771985
  },
  {
    "id": 2277769,
    "name": "Download ProsperWorks Mobile App",
    "related_resource": {
      "id": 9607579,
      "type": "company"
    },
    "assignee_id": null,
    "due_date": null,
    "reminder_date": null,
    "completed_date": null,
    "priority": "None",
    "status": "Open",
    "details": "Visit the Google Play store or the Apple App store to download the ProsperWorks Android or iPhone app.",
    "tags": [],
    "custom_fields": [],
    "date_created": 1483988829,
    "date_modified": 1483989349
  },
  {
    "id": 2277771,
    "name": "Follow up Call (sample)",
    "related_resource": {
      "id": null,
      "type": null
    },
    "assignee_id": null,
    "due_date": 1483894800,
    "reminder_date": null,
    "completed_date": null,
    "priority": "None",
    "status": "Open",
    "details": null,
    "tags": [],
    "custom_fields": [],
    "date_created": 1483988829,
    "date_modified": 1489018922
  },
  {
    "id": 2277770,
    "name": "Follow up on Price Quote (sample)",
    "related_resource": {
      "id": null,
      "type": null
    },
    "assignee_id": null,
    "due_date": 1484067600,
    "reminder_date": null,
    "completed_date": null,
    "priority": "None",
    "status": "Open",
    "details": null,
    "tags": [],
    "custom_fields": [],
    "date_created": 1483988829,
    "date_modified": 1483988829
  },
  {
    "id": 3716920,
    "name": "My First Task",
    "related_resource": {
      "id": 144296,
      "type": "project"
    },
    "assignee_id": 137658,
    "due_date": 1496799000,
    "reminder_date": null,
    "completed_date": null,
    "priority": "None",
    "status": "Open",
    "details": "This is an update",
    "tags": [],
    "custom_fields": [],
    "date_created": 1496712856,
    "date_modified": 1496776369
  }
]

List Tasks in Groups of 200

1
2
3
4
5
6
7
8
9
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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
[
  {
    "id": 1,
    "name": "Download ProsperWorks Mobile App",
    "related_resource": {
      "id": 2,
      "type": "company"
    },
    "assignee_id": null,
    "due_date": 1516813200,
    "reminder_date": null,
    "completed_date": null,
    "priority": "None",
    "status": "Open",
    "details": "Visit the Google Play store or the Apple App store to download the ProsperWorks Android or iPhone app.",
    "tags": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": null
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          9
        ]
      },
      {
        "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": 1515434871,
    "date_modified": 1516824438,
    "custom_activity_type_id": 6
  },
  {
    "id": 3,
    "name": "Follow up Call (sample)",
    "related_resource": {
      "id": 5,
      "type": "person"
    },
    "assignee_id": null,
    "due_date": 1515776400,
    "reminder_date": null,
    "completed_date": null,
    "priority": "None",
    "status": "Open",
    "details": null,
    "tags": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": null
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          9
        ]
      },
      {
        "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": 1515434871,
    "date_modified": 1516824426,
    "custom_activity_type_id": 6
  },
  {
    "id": 2,
    "name": "Follow up on Price Quote (sample)",
    "related_resource": {
      "id": 4,
      "type": "opportunity"
    },
    "assignee_id": null,
    "due_date": 1515517200,
    "reminder_date": null,
    "completed_date": 1516822940,
    "priority": "None",
    "status": "Completed",
    "details": null,
    "tags": [],
    "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": 1515434871,
    "date_modified": 1516822940,
    "custom_activity_type_id": 6
  },
  {
    "id": 6,
    "name": "New CRM Task",
    "related_resource": {
      "id": 1,
      "type": "project"
    },
    "assignee_id": 2,
    "due_date": 1516905000,
    "reminder_date": null,
    "completed_date": null,
    "priority": "High",
    "status": "Open",
    "details": null,
    "tags": [
      "tag1"
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      },
      {
        "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": 1516818999,
    "date_modified": 1516819000,
    "custom_activity_type_id": 6
  }
]

Search by Assignee Ids

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
[
  {
    "id": 6,
    "name": "New CRM Task",
    "related_resource": {
      "id": 1,
      "type": "project"
    },
    "assignee_id": 2,
    "due_date": 1516905000,
    "reminder_date": null,
    "completed_date": null,
    "priority": "High",
    "status": "Open",
    "details": null,
    "tags": [
      "tag1"
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      },
      {
        "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": 1516818999,
    "date_modified": 1516819000,
    "custom_activity_type_id": 6
  }
]

Search by Tags

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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\": [\"tag1\"]
  }
}"

 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
[
  {
    "id": 6,
    "name": "New CRM Task",
    "related_resource": {
      "id": 1,
      "type": "project"
    },
    "assignee_id": 2,
    "due_date": 1516905000,
    "reminder_date": null,
    "completed_date": null,
    "priority": "High",
    "status": "Open",
    "details": null,
    "tags": [
      "tag1"
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      },
      {
        "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": 1516818999,
    "date_modified": 1516819000,
    "custom_activity_type_id": 6
  }
]

Search by Followed

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
[
  {
    "id": 6,
    "name": "New CRM Task",
    "related_resource": {
      "id": 1,
      "type": "project"
    },
    "assignee_id": 2,
    "due_date": 1516905000,
    "reminder_date": null,
    "completed_date": null,
    "priority": "High",
    "status": "Open",
    "details": null,
    "tags": [
      "tag1"
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      },
      {
        "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": 1516818999,
    "date_modified": 1516819000,
    "custom_activity_type_id": 6
  }
]

Search by Project Ids

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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\",
  \"project_ids\": [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
[
  {
    "id": 6,
    "name": "New CRM Task",
    "related_resource": {
      "id": 1,
      "type": "project"
    },
    "assignee_id": 2,
    "due_date": 1516905000,
    "reminder_date": null,
    "completed_date": null,
    "priority": "High",
    "status": "Open",
    "details": null,
    "tags": [
      "tag1"
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      },
      {
        "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": 1516818999,
    "date_modified": 1516819000,
    "custom_activity_type_id": 6
  }
]

Search by Opportunity Ids

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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\",
  \"project_ids\": [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
[
  {
    "id": 2,
    "name": "Follow up on Price Quote (sample)",
    "related_resource": {
      "id": 4,
      "type": "opportunity"
    },
    "assignee_id": null,
    "due_date": 1515517200,
    "reminder_date": null,
    "completed_date": null,
    "priority": "None",
    "status": "Open",
    "details": null,
    "tags": [],
    "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": 1515434871,
    "date_modified": 1516820005,
    "custom_activity_type_id": 6
  }
]

Search by Statuses

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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\",
  \"statuses\": [\"Completed\"]
}"

 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": 2,
    "name": "Follow up on Price Quote (sample)",
    "related_resource": {
      "id": 4,
      "type": "opportunity"
    },
    "assignee_id": null,
    "due_date": 1515517200,
    "reminder_date": null,
    "completed_date": 1516822940,
    "priority": "None",
    "status": "Completed",
    "details": null,
    "tags": [],
    "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": 1515434871,
    "date_modified": 1516822940,
    "custom_activity_type_id": 6
  }
]

Search by Due Date

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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_due_date\": 1515764000,
  \"maximum_due_date\": 1515764000
}"

 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
[
  {
    "id": 3,
    "name": "Follow up Call (sample)",
    "related_resource": {
      "id": 5,
      "type": "person"
    },
    "assignee_id": null,
    "due_date": 1515776400,
    "reminder_date": null,
    "completed_date": null,
    "priority": "None",
    "status": "Open",
    "details": null,
    "tags": [],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": null
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      },
      {
        "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": 1515434871,
    "date_modified": 1516819079,
    "custom_activity_type_id": 6
  }
]

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.copper.com/developer_api/v1/tasks/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\": 1515744000
  }]
}"

 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
[
  {
    "id": 6,
    "name": "New CRM Task",
    "related_resource": {
      "id": 1,
      "type": "project"
    },
    "assignee_id": 2,
    "due_date": 1516905000,
    "reminder_date": null,
    "completed_date": null,
    "priority": "High",
    "status": "Open",
    "details": null,
    "tags": [
      "tag1"
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      },
      {
        "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": 1516818999,
    "date_modified": 1516819000,
    "custom_activity_type_id": 6
  }
]

Search by Multi-Select Dropdown

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
curl --location --request POST "https://api.copper.com/developer_api/v1/tasks/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
64
65
66
67
[
  {
    "id": 6,
    "name": "New CRM Task",
    "related_resource": {
      "id": 1,
      "type": "project"
    },
    "assignee_id": 2,
    "due_date": 1516905000,
    "reminder_date": null,
    "completed_date": null,
    "priority": "High",
    "status": "Open",
    "details": null,
    "tags": [
      "tag1"
    ],
    "custom_fields": [
      {
        "custom_field_definition_id": 6,
        "value": 1515744000
      },
      {
        "custom_field_definition_id": 12,
        "value": [
          8
        ]
      },
      {
        "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": 1516818999,
    "date_modified": 1516819000,
    "custom_activity_type_id": 6
  }
]

Search by 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.copper.com/developer_api/v1/tasks/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
56
57
58
59
60
61
62
63
[
  {
    "id": 2,
    "name": "Follow up on Price Quote (sample)",
    "related_resource": {
      "id": 4,
      "type": "opportunity"
    },
    "assignee_id": null,
    "due_date": 1515517200,
    "reminder_date": null,
    "completed_date": 1516822940,
    "priority": "None",
    "status": "Completed",
    "details": null,
    "tags": [],
    "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": 1515434871,
    "date_modified": 1516822940,
    "custom_activity_type_id": 6
  }
]