List

GET

Lists the timeline entries for an object.

Query parameters

objectstringRequired

The ID of the object to list timeline entries for.

collections"discussions" or "events"Optional

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

Allowed values: discussionsevents

cursorstringOptional

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

labelsstringOptional

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

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

Allowed values: afterbefore

visibilityenumOptional

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.

Allowed values: externalinternalprivatepublic

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.

GET

1 curl -G https://api.devrev.ai/timeline-entries.list \
2      -H "Authorization: Bearer <token>" \
3      -d object=PROD-12345

200Retrieved

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 -G https://api.devrev.ai/timeline-entries.list \
2	-H "Authorization: Bearer <token>" \
3	-d object=PROD-12345

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	}