List

GET

Lists a collection of work items.

Query parameters

applies_to_partstringOptional

Filters for work belonging to any of the provided parts.

created_bystringOptional

Filters for work created by any of these users.

cursorstringOptional

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

custom_fieldsmap from strings to anyOptional

Filters for custom fields.

issue.accountsstringOptional

Filters for issues with any of the provided Accounts.

issue.priorityenumOptional

Filters for issues with any of the provided priorities.

Allowed values: p0p1p2p3

issue.priority_v2longOptional

Filters for issues with any of the provided priority enum ids.

issue.rev_orgsstringOptional

Filters for issues with any of the provided Rev organizations.

issue.sla_summary.stageenumOptional

Filters for records with any of the provided SLA stages.

Allowed values: breachedcompletedpausedrunningwarning

issue.sprintstringOptional

Filters for issues with any of the sprint.

issue.subtypestringOptional

Filters for issues with any of the provided subtypes.

limitintegerOptional

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

mode"after" or "before"Optional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore

opportunity.accountstringOptional

Filters for opportunities belonging to any of the provided accounts.

opportunity.contactsstringOptional

Filters for opportunities with any of the provided contacts.

opportunity.forecast_category_v2longOptional

Filters for opportunities with any of the provided forecast category enum IDs.

opportunity.subtypestringOptional

Filters for opportunity with any of the provided subtypes.

owned_bystringOptional

Filters for work owned by any of these users.

reported_bystringOptional

Filters for work reported by any of these users.

sort_bystringOptional

Fields to sort the works by and the direction to sort them.

stage.namestringOptional

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

staged_info.is_stagedbooleanOptional

Filters for issues that are staged.

sync_metadata.external_referencestringOptional

Filters for issues with this specific external reference.

sync_metadata.last_sync_in.statusenumOptional

Filters for works with selected sync statuses.

Allowed values: failedmodifiedstagedsucceeded

sync_metadata.last_sync_in.sync_unitstringOptional

Filters for works modified with selected sync units.

sync_metadata.last_sync_out.statusenumOptional

Filters for works with selected sync statuses.

Allowed values: failedmodifiedsucceeded

sync_metadata.last_sync_out.sync_unitstringOptional

Filters for works modified with selected sync units.

sync_metadata.origin_systemstringOptional

Filters for issues synced from this specific origin system.

tagsstringOptional

Filters for work with any of the provided tags.

ticket.channelsenumOptional

Filters for tickets with any of the provided channels.

Allowed values: emailplugslacktwiliotwilio_sms

ticket.groupstringOptional

Filters for tickets belonging to specific groups.

ticket.is_spambooleanOptional

Filters for tickets that are spam.

ticket.needs_responsebooleanOptional

Filters for tickets that need response.

ticket.rev_orgstringOptional

Filters for tickets that are associated with any of the provided Rev organizations.

ticket.severityenumOptional

Filters for tickets with any of the provided severities.

Allowed values: blockerhighlowmedium

ticket.sla_summary.stageenumOptional

Filters for records with any of the provided SLA stages.

Allowed values: breachedcompletedpausedrunningwarning

ticket.source_channelstringOptional

Filters for tickets with any of the provided source channels.

ticket.subtypestringOptional

Filters for tickets with any of the provided subtypes.

typeenumOptional

Filters for work of the provided types.

Allowed values: issueopportunitytaskticket

Response

This endpoint returns an object.

workslist of objects

The list of works.

next_cursorstringOptional

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

prev_cursorstringOptional

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

GET

1 curl https://api.devrev.ai/works.list \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "works": [
3     {
4       "type": "ticket",
5       "id": "works",
6       "owned_by": [
7         {
8           "type": "sys_user",
9           "id": "works"
10         }
11       ],
12       "title": "works",
13       "actual_close_date": "2023-01-01T12:00:00Z",
14       "applies_to_part": {
15         "type": "product",
16         "id": "works",
17         "name": "works",
18         "owned_by": [
19           {
20             "type": "sys_user",
21             "id": "works"
22           }
23         ]
24       },
25       "artifacts": [
26         {
27           "id": "id"
28         }
29       ],
30       "body": "works",
31       "channels": [
32         "email"
33       ],
34       "created_by": {
35         "type": "sys_user",
36         "id": "works"
37       },
38       "created_date": "2023-01-01T12:00:00Z",
39       "custom_fields": {
40         "key": "value"
41       },
42       "custom_schema_fragments": [
43         "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
44       ],
45       "display_id": "works",
46       "group": {
47         "id": "id"
48       },
49       "modified_by": {
50         "type": "sys_user",
51         "id": "works"
52       },
53       "modified_date": "2023-01-01T12:00:00Z",
54       "needs_response": true,
55       "reported_by": [
56         {
57           "type": "sys_user",
58           "id": "works"
59         }
60       ],
61       "rev_org": {
62         "type": "rev_org",
63         "id": "works"
64       },
65       "sentiment": {
66         "id": 1000000,
67         "label": "label",
68         "ordinal": 1000000
69       },
70       "sentiment_modified_date": "2023-01-01T12:00:00Z",
71       "sentiment_summary": "works",
72       "severity": "blocker",
73       "sla_tracker": {
74         "id": "id"
75       },
76       "source_channel": "works",
77       "stage": {
78         "name": "name"
79       },
80       "stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
81       "subtype": "works",
82       "tags": [
83         {
84           "tag": {
85             "id": "id",
86             "name": "name"
87           }
88         }
89       ],
90       "target_close_date": "2023-01-01T12:00:00Z"
91     }
92   ],
93   "next_cursor": "next_cursor",
94   "prev_cursor": "prev_cursor"
95 }

Built with

1	curl https://api.devrev.ai/works.list \
2	-H "Authorization: Bearer <token>"

1	{
2	"works": [
3	{
4	"type": "ticket",
5	"id": "works",
6	"owned_by": [
7	{
8	"type": "sys_user",
9	"id": "works"
10	}
11	],
12	"title": "works",
13	"actual_close_date": "2023-01-01T12:00:00Z",
14	"applies_to_part": {
15	"type": "product",
16	"id": "works",
17	"name": "works",
18	"owned_by": [
19	{
20	"type": "sys_user",
21	"id": "works"
22	}
23	]
24	},
25	"artifacts": [
26	{
27	"id": "id"
28	}
29	],
30	"body": "works",
31	"channels": [
32	"email"
33	],
34	"created_by": {
35	"type": "sys_user",
36	"id": "works"
37	},
38	"created_date": "2023-01-01T12:00:00Z",
39	"custom_fields": {
40	"key": "value"
41	},
42	"custom_schema_fragments": [
43	"don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
44	],
45	"display_id": "works",
46	"group": {
47	"id": "id"
48	},
49	"modified_by": {
50	"type": "sys_user",
51	"id": "works"
52	},
53	"modified_date": "2023-01-01T12:00:00Z",
54	"needs_response": true,
55	"reported_by": [
56	{
57	"type": "sys_user",
58	"id": "works"
59	}
60	],
61	"rev_org": {
62	"type": "rev_org",
63	"id": "works"
64	},
65	"sentiment": {
66	"id": 1000000,
67	"label": "label",
68	"ordinal": 1000000
69	},
70	"sentiment_modified_date": "2023-01-01T12:00:00Z",
71	"sentiment_summary": "works",
72	"severity": "blocker",
73	"sla_tracker": {
74	"id": "id"
75	},
76	"source_channel": "works",
77	"stage": {
78	"name": "name"
79	},
80	"stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
81	"subtype": "works",
82	"tags": [
83	{
84	"tag": {
85	"id": "id",
86	"name": "name"
87	}
88	}
89	],
90	"target_close_date": "2023-01-01T12:00:00Z"
91	}
92	],
93	"next_cursor": "next_cursor",
94	"prev_cursor": "prev_cursor"
95	}