Get Engagement (POST)

POST

https://api.devrev.ai/engagements.get

POST

/engagements.get

1 curl -X POST https://api.devrev.ai/engagements.get \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "id": "foo"
6 }'

Try it

200engagementsGetPostExample

1 {
2   "engagement": {
3     "id": "foo",
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           "type": "foo",
13           "name": "foo",
14           "size": 42
15         }
16       },
17       "email": "foo",
18       "full_name": "foo",
19       "state": "active"
20     },
21     "created_date": "2023-01-01T12:00:00.000Z",
22     "description": "foo",
23     "display_id": "foo",
24     "modified_by": {
25       "display_id": "foo",
26       "id": "foo",
27       "display_name": "foo",
28       "display_picture": {
29         "display_id": "foo",
30         "id": "foo",
31         "file": {
32           "type": "foo",
33           "name": "foo",
34           "size": 42
35         }
36       },
37       "email": "foo",
38       "full_name": "foo",
39       "state": "active"
40     },
41     "modified_date": "2023-01-01T12:00:00.000Z"
42   }
43 }

Gets the engagement record.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.

idstringRequiredformat: "id"

The engagement ID.

Response

Success.

engagementobject

Headers

Request

Response

Errors