• About
    • For Developers
  • API Reference
    • Changelog
  • Guides
    • Account creation
    • Agents async API
    • Links
API Referenceworks

List Works

GET
https://api.devrev.ai/works.list
GET
/works.list
1curl https://api.devrev.ai/works.list \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2  "works": [
3    {
4      "created_by": {
5        "display_id": "string",
6        "id": "string",
7        "display_name": "string",
8        "display_picture": {
9          "display_id": "string",
10          "id": "string",
11          "file": {
12            "type": "string",
13            "name": "string",
14            "size": 1
15          }
16        },
17        "email": "string",
18        "full_name": "string",
19        "state": "active"
20      },
21      "created_date": "2023-01-01T12:00:00.000Z",
22      "display_id": "string",
23      "id": "string",
24      "modified_by": {
25        "display_id": "string",
26        "id": "string",
27        "display_name": "string",
28        "display_picture": {
29          "display_id": "string",
30          "id": "string",
31          "file": {
32            "type": "string",
33            "name": "string",
34            "size": 1
35          }
36        },
37        "email": "string",
38        "full_name": "string",
39        "state": "active"
40      },
41      "modified_date": "2023-01-01T12:00:00.000Z",
42      "actual_close_date": "2023-01-01T12:00:00.000Z",
43      "applies_to_part": {
44        "display_id": "string",
45        "id": "string",
46        "name": "string",
47        "owned_by": [
48          {
49            "display_id": {},
50            "id": {},
51            "display_name": {},
52            "display_picture": {},
53            "email": {},
54            "full_name": {},
55            "state": {}
56          }
57        ],
58        "sync_metadata": {
59          "external_reference": "string",
60          "origin_system": "string"
61        }
62      },
63      "artifacts": [
64        {
65          "display_id": "string",
66          "id": "string",
67          "file": {
68            "type": "string",
69            "name": "string",
70            "size": 1
71          }
72        }
73      ],
74      "body": "string",
75      "custom_fields": {},
76      "custom_schema_fragments": [
77        "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
78      ],
79      "owned_by": [
80        {
81          "display_id": "string",
82          "id": "string",
83          "display_name": "string",
84          "display_picture": {
85            "display_id": "string",
86            "id": "string",
87            "file": {
88              "type": "string",
89              "name": "string",
90              "size": 1
91            }
92          },
93          "email": "string",
94          "full_name": "string",
95          "state": "active"
96        }
97      ],
98      "reported_by": [
99        {
100          "display_id": "string",
101          "id": "string",
102          "display_name": "string",
103          "display_picture": {
104            "display_id": "string",
105            "id": "string",
106            "file": {
107              "type": "string",
108              "name": "string",
109              "size": 1
110            }
111          },
112          "email": "string",
113          "full_name": "string",
114          "state": "active"
115        }
116      ],
117      "stage": {
118        "name": "string",
119        "notes": "string",
120        "ordinal": 1,
121        "stage": {
122          "display_id": "string",
123          "id": "string",
124          "name": "string"
125        },
126        "state": {
127          "display_id": "string",
128          "id": "string",
129          "is_final": true,
130          "name": "string"
131        }
132      },
133      "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
134      "subtype": "string",
135      "sync_metadata": {
136        "external_reference": "string",
137        "last_sync_in": {
138          "status": "failed",
139          "sync_date": "2023-01-01T12:00:00.000Z",
140          "sync_unit": {
141            "display_id": "string",
142            "id": "string",
143            "external_system_type": "adaas",
144            "is_archived": true,
145            "name": "string",
146            "sync_run": {
147              "mode": "initial",
148              "progress": {
149                "state": "completed"
150              }
151            },
152            "sync_type": "manual"
153          }
154        },
155        "last_sync_out": {
156          "status": "failed",
157          "sync_date": "2023-01-01T12:00:00.000Z",
158          "sync_unit": {
159            "display_id": "string",
160            "id": "string",
161            "external_system_type": "adaas",
162            "is_archived": true,
163            "name": "string",
164            "sync_run": {
165              "mode": "initial",
166              "progress": {
167                "state": "completed"
168              }
169            },
170            "sync_type": "manual"
171          }
172        },
173        "origin_system": "string"
174      },
175      "tags": [
176        {
177          "tag": {
178            "display_id": "string",
179            "id": "string",
180            "name": "string",
181            "style_new": {
182              "color": "string"
183            }
184          },
185          "value": "string"
186        }
187      ],
188      "target_close_date": "2023-01-01T12:00:00.000Z",
189      "title": "string",
190      "actual_start_date": "2023-01-01T12:00:00.000Z",
191      "developed_with": [
192        {
193          "display_id": "string",
194          "id": "string",
195          "name": "string",
196          "owned_by": [
197            {
198              "display_id": "string",
199              "id": "string",
200              "display_name": "string",
201              "display_picture": {},
202              "email": "string",
203              "full_name": "string",
204              "state": "active"
205            }
206          ],
207          "sync_metadata": {
208            "external_reference": "string",
209            "origin_system": "string"
210          }
211        }
212      ],
213      "estimated_effort": 1.1,
214      "priority": "p0",
215      "priority_v2": {
216        "id": 1,
217        "label": "string",
218        "ordinal": 1,
219        "value": null
220      },
221      "sla_summary": {
222        "closest_to_breach_metric": "string",
223        "org_schedule": {
224          "display_id": "string",
225          "id": "string",
226          "name": "string",
227          "status": "archived",
228          "timezone": "string",
229          "valid_until": "2023-01-01T12:00:00.000Z"
230        },
231        "remaining_time": 1,
232        "sla_tracker": {
233          "created_by": {
234            "display_id": "string",
235            "id": "string",
236            "display_name": "string",
237            "display_picture": {
238              "display_id": {},
239              "id": {},
240              "file": {}
241            },
242            "email": "string",
243            "full_name": "string",
244            "state": "active"
245          },
246          "created_date": "2023-01-01T12:00:00.000Z",
247          "display_id": "string",
248          "id": "string",
249          "modified_by": {
250            "display_id": "string",
251            "id": "string",
252            "display_name": "string",
253            "display_picture": {
254              "display_id": {},
255              "id": {},
256              "file": {}
257            },
258            "email": "string",
259            "full_name": "string",
260            "state": "active"
261          },
262          "modified_date": "2023-01-01T12:00:00.000Z",
263          "applies_to_id": "string",
264          "applies_to_type": "conversation",
265          "metric_target_summaries": [
266            {
267              "breached_at": "2023-01-01T12:00:00.000Z",
268              "completed_at": "2023-01-01T12:00:00.000Z",
269              "completed_in": 1,
270              "in_policy": true,
271              "is_out_of_schedule": true,
272              "metric_definition": {
273                "display_id": "string",
274                "id": "string",
275                "name": "string"
276              },
277              "next_schedule_transition": "2023-01-01T12:00:00.000Z",
278              "org_schedule": {
279                "display_id": "string",
280                "id": "string",
281                "name": "string",
282                "status": "archived",
283                "timezone": "string",
284                "valid_until": "2023-01-01T12:00:00.000Z"
285              },
286              "remaining_time": 1,
287              "stage": "string",
288              "status": "string",
289              "target_time": "2023-01-01T12:00:00.000Z",
290              "warning_target_time": "2023-01-01T12:00:00.000Z"
291            }
292          ],
293          "removed_sla_metric_history": [
294            {
295              "metric_definition": {
296                "display_id": "string",
297                "id": "string",
298                "name": "string"
299              },
300              "removed_at": "2023-01-01T12:00:00.000Z",
301              "removed_by": {
302                "display_id": "string",
303                "id": "string",
304                "display_name": "string",
305                "display_picture": {},
306                "email": "string",
307                "full_name": "string",
308                "state": "active"
309              }
310            }
311          ],
312          "sla": {
313            "display_id": "string",
314            "id": "string",
315            "name": "string",
316            "sla_type": "external",
317            "status": "archived"
318          },
319          "sla_policy_id": "string",
320          "stage": "string",
321          "status": "string"
322        },
323        "stage": "breached",
324        "target_time": "2023-01-01T12:00:00.000Z"
325      },
326      "sla_tracker": {
327        "display_id": "string",
328        "id": "string",
329        "applies_to_type": "conversation"
330      },
331      "sprint": {
332        "type": "curated",
333        "end_date": "2023-01-01T12:00:00.000Z",
334        "id": "string",
335        "name": "string",
336        "start_date": "2023-01-01T12:00:00.000Z",
337        "state": "active"
338      },
339      "target_start_date": "2023-01-01T12:00:00.000Z"
340    }
341  ],
342  "next_cursor": "string",
343  "prev_cursor": "string"
344}
Lists a collection of work items.

Headers

AuthorizationstringRequired
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Query parameters

applies_to_partlist of stringsOptional
Filters for work belonging to any of the provided parts.
created_bylist of stringsOptional
Filters for work created by any of these users.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
custom_fieldsobjectOptional
Filters for custom fields.
issue.accountslist of stringsOptional
Filters for issues with any of the provided accounts.
issue.prioritylist of enumsOptional
Filters for issues with any of the provided priorities.
Allowed values:
issue.priority_v2list of longsOptional
Filters for issues with any of the provided priority enum ids.
issue.rev_orgslist of stringsOptional
Filters for issues with any of the provided Rev organizations.
issue.sla_summary.stagelist of enumsOptional
Filters for records with any of the provided SLA stages.
Allowed values:
issue.sprintlist of stringsOptional
Filters for issues with any of the sprint.
issue.subtypelist of stringsOptional
Filters for issues with any of the provided subtypes.
limitintegerOptional
The maximum number of works to return. The default is '50'.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
modified_bylist of stringsOptional
Filters for work modified by any of these users.
opportunity.accountlist of stringsOptional
Filters for opportunities belonging to any of the provided accounts.
opportunity.contactslist of stringsOptional
Filters for opportunities with any of the provided contacts.
opportunity.forecast_category_v2list of longsOptional
Filters for opportunities with any of the provided forecast category enum IDs.
opportunity.subtypelist of stringsOptional
Filters for opportunity with any of the provided subtypes.
owned_bylist of stringsOptional
Filters for work owned by any of these users.
reported_bylist of stringsOptional
Filters for work reported by any of these users.
sort_bylist of stringsOptional
Fields to sort the works by and the direction to sort them.
stage.namelist of stringsOptional
Filters for records in the provided stage(s) by name.
staged_info.is_stagedbooleanOptional
Filters for issues that are staged.
statelist of stringsOptional
Filters for work with any of the provided states.
sync_metadata.external_referencelist of stringsOptional
Filters for issues with this specific external reference.
sync_metadata.last_sync_in.statuslist of enumsOptional
Filters for works with selected sync statuses.
Allowed values:
sync_metadata.last_sync_in.sync_historylist of stringsOptional
Filters for works modified with selected sync history.
sync_metadata.last_sync_in.sync_unitlist of stringsOptional
Filters for works modified with selected sync units.
sync_metadata.last_sync_out.statuslist of enumsOptional
Filters for works with selected sync statuses.
Allowed values:
sync_metadata.last_sync_out.sync_historylist of stringsOptional
Filters for works modified with selected sync history.
sync_metadata.last_sync_out.sync_unitlist of stringsOptional
Filters for works modified with selected sync units.
sync_metadata.origin_systemlist of stringsOptional
Filters for issues synced from this specific origin system.
tagslist of stringsOptional
Filters for work with any of the provided tags.
ticket.brandlist of stringsOptional
Filters for tickets that are associated with any of the brands.
ticket.channelslist of enumsOptional
Filters for tickets with any of the provided channels.
Allowed values:
ticket.channels_v2list of stringsOptional
Filters for tickets that are associated with any of the channels.
ticket.grouplist of stringsOptional
Filters for tickets belonging to specific groups.
ticket.is_frozenbooleanOptional
Filters for frozen tickets.
ticket.is_spambooleanOptional
Filters for tickets that are spam.
ticket.needs_responsebooleanOptional
Filters for tickets that need response.
ticket.rev_orglist of stringsOptional
Filters for tickets that are associated with any of the provided Rev organizations.
ticket.severitylist of enumsOptional
Filters for tickets with any of the provided severities.
Allowed values:
ticket.sla_summary.stagelist of enumsOptional
Filters for records with any of the provided SLA stages.
Allowed values:
ticket.source_channellist of stringsOptional
Filters for tickets with any of the provided source channels.
ticket.source_channel_v2list of stringsOptional
Filters for tickets that are associated with any of the source channels.
ticket.subtypelist of stringsOptional
Filters for tickets with any of the provided subtypes.
typelist of enumsOptional
Filters for work of the provided types.
Allowed values:

Response

Success.
workslist of objects
The list of works.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors

Was this page helpful?
Previous

List Works (POST)

Next
Built with
Filters for work belonging to any of the provided parts.
Filters for work created by any of these users.
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
Filters for custom fields.
Filters for issues with any of the provided accounts.
Filters for issues with any of the provided priorities.
Filters for issues with any of the provided priority enum ids.
Filters for issues with any of the provided Rev organizations.
Filters for records with any of the provided SLA stages.
Filters for issues with any of the sprint.
Filters for issues with any of the provided subtypes.
The maximum number of works to return. The default is '50'.
The iteration mode to use, otherwise if not set, then "after" is used.
Filters for work modified by any of these users.
Filters for opportunities belonging to any of the provided accounts.
Filters for opportunities with any of the provided contacts.
Filters for opportunities with any of the provided forecast category enum IDs.
Filters for opportunity with any of the provided subtypes.
Filters for work owned by any of these users.
Filters for work reported by any of these users.
Fields to sort the works by and the direction to sort them.
Filters for issues that are staged.
Filters for work with any of the provided states.
Filters for issues with this specific external reference.
Filters for works with selected sync statuses.
Filters for works modified with selected sync history.
Filters for works modified with selected sync units.
Filters for works with selected sync statuses.
Filters for works modified with selected sync history.
Filters for works modified with selected sync units.
Filters for issues synced from this specific origin system.
Filters for work with any of the provided tags.
Filters for tickets that are associated with any of the brands.
Filters for tickets with any of the provided channels.
Filters for tickets that are associated with any of the channels.
Filters for tickets belonging to specific groups.
Filters for frozen tickets.
Filters for tickets that are spam.
Filters for tickets that need response.
Filters for tickets that are associated with any of the provided Rev organizations.
Filters for tickets with any of the provided severities.
Filters for records with any of the provided SLA stages.
Filters for tickets with any of the provided source channels.
Filters for tickets that are associated with any of the source channels.
Filters for tickets with any of the provided subtypes.
Filters for work of the provided types.
Success.

List Works (POST)

Bearer authentication of the form Bearer <token>, where token is your auth token.

Filters for records in the provided stage(s) by name.