• About
    • For Developers
  • API Reference
    • Changelog
  • Guides
    • Account creation
    • Agents async API
    • Links
API Referenceengagements

Beta
POST
https://api.devrev.ai/engagements.list
POST
/engagements.list
1curl -X POST https://api.devrev.ai/engagements.list \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
Try it
1{
2  "engagements": [
3    {
4      "id": "string",
5      "created_by": {
6        "display_id": "string",
7        "id": "string",
8        "display_name": "string",
9        "display_picture": {
10          "display_id": "string",
11          "id": "string",
12          "file": {
13            "type": "string",
14            "name": "string",
15            "size": 1
16          }
17        },
18        "email": "string",
19        "full_name": "string",
20        "state": "active"
21      },
22      "created_date": "2023-01-01T12:00:00.000Z",
23      "description": "string",
24      "display_id": "string",
25      "modified_by": {
26        "display_id": "string",
27        "id": "string",
28        "display_name": "string",
29        "display_picture": {
30          "display_id": "string",
31          "id": "string",
32          "file": {
33            "type": "string",
34            "name": "string",
35            "size": 1
36          }
37        },
38        "email": "string",
39        "full_name": "string",
40        "state": "active"
41      },
42      "modified_date": "2023-01-01T12:00:00.000Z"
43    }
44  ],
45  "next_cursor": "string",
46  "prev_cursor": "string"
47}
Lists the engagement records.

Headers

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

Request

This endpoint expects an object.
typelist of enumsOptional
Filters for engagement of the provided types.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
external_reflist of stringsOptional
Filters for meetings with the provided external_refs.
limitintegerOptional
The maximum number of engagements to return.
memberslist of stringsOptional
Filters for engagement of the provided members.
modeenumOptional
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.
Allowed values:
parentlist of stringsOptional
Filters for engagements with the provided parent.
sort_bylist of stringsOptional
Fields to sort the engagements by and the direction to sort them.

Response

Success.
engagementslist of objects
The list of engagements.
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

Update Engagement

Next
Built with
Success.

Filters for meetings with the provided external_refs.

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.

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

List Engagements (POST)