Integrations API
Users
Returns a list of users.
DeprecatedGET
header
Authorization<token>email?stringemail to search for
phone_number?stringphone number to search for
limit?integerMaximum number of items per page. With upper bound set to 200.
Range
value <= 200A JSON array of users
application/json- response
data*array<User>paging?curl -X GET 'https://example.com/v1/users' \ -H 'Authorization: <API token>'{}
"data": [],
{}
"id": "string",
"email": "string",
"name": "string",
"roles": [],
"string"
"avatar_url": "string",
"phone_number": "string"
"paging": {}
"cursors": {},
"after": "string",
"before": "string"
"next_page": "string",
"prev_page": "string"
Create a user
DeprecatedPOST
header
Authorization<token>The user to create
body*CreateUserInputapplication/jsonThe user was created
application/json- response
data*Userpaging?curl -X POST 'https://example.com/v1/users' \ -H 'Authorization: <API token>' \ -H 'Content-Type: application/json' \ -d '{}'{}
"data": {},
"id": "string",
"email": "string",
"name": "string",
"roles": [],
"string"
"avatar_url": "string",
"phone_number": "string"
"paging": {}
"cursors": {},
"after": "string",
"before": "string"
"next_page": "string",
"prev_page": "string"
GET
header
Authorization<token>userId*stringId of the requester
limit?integerMaximum number of items per page. With upper bound set to 200.
Range
value <= 200A JSON array of conversations
application/json- response
data*array<>paging?curl -X GET 'https://example.com/v1/users/{userId}/requested_conversations' \ -H 'Authorization: <API token>'{}
"data": [],
{}
"id": 0,
"created_at": "2015-11-30T00:00:00:000Z",
"requester_id": "string",
"channel": "widget_chat",
"direction": "outbound",
"queued_at": "2015-11-30T00:00:00:000Z",
"queue_id": "string",
"status": "open",
"status_updated_at": "2015-11-30T00:00:00:000Z",
"attributes": {},
"assigned_to": "string",
"assigned_at": "2015-11-30T00:00:00:000Z"
"paging": {}
"cursors": {},
"after": "string",
"before": "string"
"next_page": "string",
"prev_page": "string"
POST
header
Authorization<token>Entity info to schedule anonymization
body*CreateAnonymizationRequestInputapplication/jsonScheduled anonymization
application/json- response
data?ScheduleAnonymizationResponsecurl -X POST 'https://example.com/v1/anonymization_request' \ -H 'Authorization: <API token>' \ -H 'Content-Type: application/json' \ -d '{ "entity_id": "string", "entity_type": "user"}'{}
"data": {}
"id": "string",
"target_entity_id": "string",
"entity_type": "user",
"initiated_at": "string",
"requested_by": "string",
"processed_at": "string"
GET
header
Authorization<token>requestId*stringAnonymization request
application/json- response
data?ScheduleAnonymizationResponsecurl -X GET 'https://example.com/v1/anonymization_request/{requestId}' \ -H 'Authorization: <API token>'{}
"data": {}
"id": "string",
"target_entity_id": "string",
"entity_type": "user",
"initiated_at": "string",
"requested_by": "string",
"processed_at": "string"