List Timeline Entries (POST)

POST

Lists the timeline entries for an object.

Request

This endpoint expects an object.

objectstringRequiredformat: "id"

The ID of the object to list timeline entries for.

cursorstringOptionalformat: "text"

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

limitintegerOptional

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

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

The response to listing timeline entries for an object.

timeline_entrieslist of objects

The timeline entries for the object.

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

200timelineEntriesListPostExample

1 {
2   "timeline_entries": [
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       "object": "foo",
35       "object_display_id": "foo",
36       "object_type": "capability",
37       "visibility": "external",
38       "artifacts": [
39         {
40           "display_id": "foo",
41           "id": "foo",
42           "file": {
43             "type": "foo",
44             "name": "foo",
45             "size": 42
46           }
47         }
48       ],
49       "body": "foo",
50       "body_type": "data",
51       "references": [
52         {
53           "display_id": "foo",
54           "id": "foo"
55         }
56       ],
57       "snap_kit_body": {
58         "body": {},
59         "snap_in_action_name": "foo",
60         "snap_in_id": "foo"
61       },
62       "snap_widget_body": [
63         {
64           "type": "foo"
65         }
66       ]
67     }
68   ],
69   "next_cursor": "foo",
70   "prev_cursor": "foo"
71 }

Update Timeline Entry

Up Next

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	"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	"object": "foo",
35	"object_display_id": "foo",
36	"object_type": "capability",
37	"visibility": "external",
38	"artifacts": [
39	{
40	"display_id": "foo",
41	"id": "foo",
42	"file": {
43	"type": "foo",
44	"name": "foo",
45	"size": 42
46	}
47	}
48	],
49	"body": "foo",
50	"body_type": "data",
51	"references": [
52	{
53	"display_id": "foo",
54	"id": "foo"
55	}
56	],
57	"snap_kit_body": {
58	"body": {},
59	"snap_in_action_name": "foo",
60	"snap_in_id": "foo"
61	},
62	"snap_widget_body": [
63	{
64	"type": "foo"
65	}
66	]
67	}
68	],
69	"next_cursor": "foo",
70	"prev_cursor": "foo"
71	}