List Post

POST

Lists the timeline entries for an object.

Request

This endpoint expects an object.

objectstringRequired

The ID of the object to list timeline entries for.

collectionslist of "discussions" or "events"Optional

Allowed values: discussionsevents

The collection(s) to list entries from, otherwise if not provided, all entries are returned.

cursorstringOptional

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

labelslist of stringsOptional

Filters for entries containing at least one of the provided labels, otherwise if no labels are provided, then no label filtering is done.

limitintegerOptional

The maximum number of entries to return. If not set, then this defaults to 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.

visibilitylist of enumsOptional

Allowed values: externalinternalprivatepublic

The visibility of the timeline entries to filter for. Note this is a strict filter, such that only entries with the exact visibilities specified will be returned.

Response

This endpoint returns an object.

timeline_entrieslist of objects

The timeline entries for the object.

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/timeline-entries.list \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "object": "PROD-12345"
6 }'

200Successful

1 {
2   "timeline_entries": [
3     {
4       "type": "timeline_comment",
5       "id": "timeline_entries",
6       "object": "timeline_entries",
7       "object_display_id": "timeline_entries",
8       "artifacts": [
9         {
10           "id": "id"
11         }
12       ],
13       "body": "timeline_entries",
14       "body_type": "data",
15       "created_by": {
16         "type": "sys_user",
17         "id": "timeline_entries"
18       },
19       "created_date": "2023-01-01T12:00:00Z",
20       "display_id": "timeline_entries",
21       "external_ref": "timeline_entries",
22       "labels": [
23         "timeline_entries"
24       ],
25       "modified_by": {
26         "type": "sys_user",
27         "id": "timeline_entries"
28       },
29       "modified_date": "2023-01-01T12:00:00Z",
30       "object_type": "account",
31       "panels": [
32         "alerts"
33       ],
34       "reactions": [
35         {}
36       ],
37       "snap_widget_body": [
38         {
39           "type": "email_preview",
40           "bcc": [
41             {
42               "address": "address"
43             }
44           ],
45           "cc": [
46             {
47               "address": "address"
48             }
49           ],
50           "from": [
51             {
52               "address": "address"
53             }
54           ],
55           "id": "timeline_entries",
56           "inlines": [
57             {}
58           ],
59           "name": "timeline_entries",
60           "references": [
61             "timeline_entries"
62           ],
63           "reply_to": [
64             {
65               "address": "address"
66             }
67           ],
68           "status": "draft",
69           "to": [
70             {
71               "address": "address"
72             }
73           ],
74           "created_date": "2023-01-01T12:00:00Z",
75           "modified_date": "2023-01-01T12:00:00Z",
76           "sent_timestamp": "2023-01-01T12:00:00Z"
77         }
78       ],
79       "visibility": "external"
80     }
81   ],
82   "next_cursor": "next_cursor",
83   "prev_cursor": "prev_cursor"
84 }

Built with

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

1	{
2	"timeline_entries": [
3	{
4	"type": "timeline_comment",
5	"id": "timeline_entries",
6	"object": "timeline_entries",
7	"object_display_id": "timeline_entries",
8	"artifacts": [
9	{
10	"id": "id"
11	}
12	],
13	"body": "timeline_entries",
14	"body_type": "data",
15	"created_by": {
16	"type": "sys_user",
17	"id": "timeline_entries"
18	},
19	"created_date": "2023-01-01T12:00:00Z",
20	"display_id": "timeline_entries",
21	"external_ref": "timeline_entries",
22	"labels": [
23	"timeline_entries"
24	],
25	"modified_by": {
26	"type": "sys_user",
27	"id": "timeline_entries"
28	},
29	"modified_date": "2023-01-01T12:00:00Z",
30	"object_type": "account",
31	"panels": [
32	"alerts"
33	],
34	"reactions": [
35	{}
36	],
37	"snap_widget_body": [
38	{
39	"type": "email_preview",
40	"bcc": [
41	{
42	"address": "address"
43	}
44	],
45	"cc": [
46	{
47	"address": "address"
48	}
49	],
50	"from": [
51	{
52	"address": "address"
53	}
54	],
55	"id": "timeline_entries",
56	"inlines": [
57	{}
58	],
59	"name": "timeline_entries",
60	"references": [
61	"timeline_entries"
62	],
63	"reply_to": [
64	{
65	"address": "address"
66	}
67	],
68	"status": "draft",
69	"to": [
70	{
71	"address": "address"
72	}
73	],
74	"created_date": "2023-01-01T12:00:00Z",
75	"modified_date": "2023-01-01T12:00:00Z",
76	"sent_timestamp": "2023-01-01T12:00:00Z"
77	}
78	],
79	"visibility": "external"
80	}
81	],
82	"next_cursor": "next_cursor",
83	"prev_cursor": "prev_cursor"
84	}