List Works (POST)

POST

Lists a collection of work items.

Request

This endpoint expects an object.

typelist of enumsOptional

Allowed values: issueopportunitytaskticket

Filters for work of the provided types.

actual_close_dateobjectOptional

Provides ways to specify date ranges on objects.

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.

created_dateobjectOptional

Provides ways to specify date ranges on objects.

cursorstringOptionalformat: "text"

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

custom_fieldsobjectOptional

Filters for custom fields.

issueobjectOptional

limitintegerOptional

The maximum number of works to return. The default is ‘50’.

modeenumOptional

Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

modified_bylist of stringsOptional

Filters for work modified by any of these users.

modified_dateobjectOptional

Provides ways to specify date ranges on objects.

opportunityobjectOptional

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.

stageobjectOptional

The filter for stages.

staged_infoobjectOptional

statelist of stringsOptional

Filters for work with any of the provided states.

sync_metadataobjectOptional

tagslist of stringsOptional

Filters for work with any of the provided tags.

target_close_dateobjectOptional

Provides ways to specify date ranges on objects.

ticketobjectOptional

Response

Success.

workslist of objects

The list of works.

next_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors

POST

1 curl -X POST https://api.devrev.ai/works.list \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200worksListPostExample

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

Update Work

Up Next

Built with

1	curl -X POST https://api.devrev.ai/works.list \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

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