List Post

POST

Lists a collection of work items.

Request

This endpoint expects an object.

typelist of "issue" or "ticket"Optional

Allowed values: issueticket

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.

cursorstringOptional

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

issueobjectOptional

limitintegerOptional

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

mode"after" or "before"Optional

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_dateobjectOptional

Provides ways to specify date ranges on objects.

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.

stageobjectOptional

The filter for stages.

staged_infoobjectOptional

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_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.

POST

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

200Successful

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       "applies_to_part": {
14         "type": "product",
15         "id": "works",
16         "name": "works",
17         "owned_by": [
18           {
19             "type": "sys_user",
20             "id": "works"
21           }
22         ]
23       },
24       "artifacts": [
25         {
26           "id": "id"
27         }
28       ],
29       "body": "works",
30       "channels": [
31         "email"
32       ],
33       "created_by": {
34         "type": "sys_user",
35         "id": "works"
36       },
37       "created_date": "2023-01-01T12:00:00Z",
38       "display_id": "works",
39       "group": {
40         "id": "id"
41       },
42       "modified_by": {
43         "type": "sys_user",
44         "id": "works"
45       },
46       "modified_date": "2023-01-01T12:00:00Z",
47       "needs_response": true,
48       "reported_by": [
49         {
50           "type": "sys_user",
51           "id": "works"
52         }
53       ],
54       "rev_org": {
55         "type": "rev_org",
56         "id": "works"
57       },
58       "sentiment": {
59         "id": 1000000,
60         "label": "label",
61         "ordinal": 1000000
62       },
63       "sentiment_modified_date": "2023-01-01T12:00:00Z",
64       "sentiment_summary": "works",
65       "severity": "blocker",
66       "sla_tracker": {
67         "id": "id"
68       },
69       "source_channel": "works",
70       "stage": {
71         "name": "name"
72       },
73       "tags": [
74         {
75           "tag": {
76             "id": "id",
77             "name": "name"
78           }
79         }
80       ],
81       "target_close_date": "2023-01-01T12:00:00Z"
82     }
83   ],
84   "next_cursor": "next_cursor",
85   "prev_cursor": "prev_cursor"
86 }

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