Get Engagement

Beta

GET

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

GET

/engagements.get

1 curl -G https://api.devrev.ai/engagements.get \
2      -H "Authorization: Bearer <token>" \
3      -d id=id

Try it

200Retrieved

1 {
2   "engagement": {
3     "id": "string",
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     "description": "string",
23     "display_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   }
43 }

Gets the engagement record.

Authentication

AuthorizationBearer

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

Query parameters

idstringRequiredformat: "id"

The engagement ID.

Response

Success.

engagementobject

Authentication

Query parameters

Response

Errors