• About
    • For Developers
    • Authentication
    • Pagination
    • Versioning
    • Rate Limits
    • Errors
  • API Reference
    • Getting started
    • Changelog
  • Guides
    • Webhooks
    • Restricted messages on a timeline
    • Object customization
    • Custom objects
  • SDKs
    • Push notifications for mobile
  • Snap-in development
    • Concepts
    • Development best practices
    • Locally testing snap-ins
    • Handling errors and retrying
    • Debugging
    • Quotas and limits
    • Upgrade snap-ins
    • Code Samples
    • Marketplace listings
  • AirSync
    • Getting started
    • Examples of snap-ins
    • Deploy to organization
    • Publish to the marketplace
    • MCP integration
    • Common issues
    • Supported DevRev object types
API Referencetimeline-entries

List Timeline Entries

GET
https://api.devrev.ai/timeline-entries.list
GET
/timeline-entries.list
1curl -G https://api.devrev.ai/timeline-entries.list \
2     -H "Authorization: Bearer <token>" \
3     -d object=PROD-12345
Try it
200Retrieved
1{
2  "timeline_entries": [
3    {
4      "created_by": {
5        "display_id": "string",
6        "id": "string",
7        "display_name": "string",
8        "display_picture": {
9          "display_id": "string",
10          "id": "string",
11          "file": {
12            "type": "string",
13            "name": "string",
14            "size": 1
15          }
16        },
17        "email": "string",
18        "full_name": "string",
19        "state": "active"
20      },
21      "created_date": "2023-01-01T12:00:00.000Z",
22      "display_id": "string",
23      "id": "string",
24      "modified_by": {
25        "display_id": "string",
26        "id": "string",
27        "display_name": "string",
28        "display_picture": {
29          "display_id": "string",
30          "id": "string",
31          "file": {
32            "type": "string",
33            "name": "string",
34            "size": 1
35          }
36        },
37        "email": "string",
38        "full_name": "string",
39        "state": "active"
40      },
41      "modified_date": "2023-01-01T12:00:00.000Z",
42      "object": "string",
43      "object_display_id": "string",
44      "object_type": "article",
45      "visibility": "external",
46      "artifacts": [
47        {
48          "display_id": "string",
49          "id": "string",
50          "file": {
51            "type": "string",
52            "name": "string",
53            "size": 1
54          }
55        }
56      ],
57      "body": "string",
58      "body_type": "data",
59      "references": [
60        {
61          "display_id": "string",
62          "id": "string",
63          "article_type": "article",
64          "resource": {
65            "artifacts": [
66              {
67                "display_id": "string",
68                "id": "string",
69                "file": {
70                  "type": "string",
71                  "name": "string",
72                  "size": 1
73                }
74              }
75            ],
76            "url": "string"
77          },
78          "title": "string"
79        }
80      ],
81      "snap_kit_body": {
82        "body": {},
83        "snap_in_action_name": "string",
84        "snap_in_id": "string"
85      },
86      "snap_widget_body": [
87        {
88          "type": "string"
89        }
90      ]
91    }
92  ],
93  "next_cursor": "string",
94  "prev_cursor": "string"
95}
Lists the timeline entries for an object.

Headers

AuthorizationstringRequired
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Query parameters

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
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
visibilitylist of enumsOptional
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:

Response

The response to listing timeline entries for an object.
timeline_entrieslist of objects
The timeline entries for the object.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors

Was this page helpful?
Previous

List Timeline Entries (POST)

Next
Built with
The ID of the object to list timeline entries for.
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
The iteration mode to use, otherwise if not set, then "after" is used.
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.
The response to listing timeline entries for an object.

List Timeline Entries (POST)

The maximum number of entries to return. If not set, then this defaults to 50.

Bearer authentication of the form Bearer <token>, where token is your auth token.