Api referencesContacts
List contacts
This request/endpoint is platform-agnostic (e.g., WhatsApp, website) and returns a list of contacts along with their associated profile data. It also supports various filtering options in the request
POST https://api-v7.express-chat.com/inbox/users
Headers
| Name | Value |
|---|---|
| Content-Type | application/json |
| Authorization | Bearer <token> |
| authtype | Key |
Request Body
The request body consists of a JavaScript Object Notation (JSON) object containing the fields described in the table below. Examples of the request body can be found in the #sample-requests section.
| Field | Type | Description |
|---|---|---|
| searchText | string | Search text to filter contacts. |
| tags | array | Filter contacts based on an array of existing tag names |
| status | array | An array of status values to filter contacts. |
| isOnline | boolean | Indicates whether contacts are online. |
| _botWebsite | array | Filter contacts based on interactions on the website. |
| _botWhatsapp | array | Filter contacts based on interactions on WhatsApp. |
| _botFacebook | array | Filter contacts based on interactions on Facebook. |
| _agentAssigned | array | Filter contacts assigned to specific agents. |
| segments | array | An array of segments to filter contacts. |
| lastSeenAt | object | Date range filter for the last seen timestamp. |
| createdAt | object | Date range filter for the creation timestamp. |
| userInteracted | boolean | Filter contacts based on whether they interacted. |
| lastMessageBy | array | Filter contacts based on the last message sender. |
| isLiveChatActive | boolean | Indicates whether live chat is active for contacts. |
| hasOrdered | object | Filter contacts based on their order history. |
Responses
Sample Requests
Replace <token> in the below example requests with your valid Bearer token and customize the request body filters as needed for your use case.
curl 'https://api-v7.express.com/inbox/users'
-X 'POST'
-H 'Authorization: Bearer <token>'
-H 'Content-Type: application/json'
-H 'authtype: Key'
-d '{
"searchText": "",
"tags": [],
"status": [],
"isOnline": false,
"_botWebsite": [],
"_botWhatsapp": [],
"_botTelegram": [],
"_botFacebook": [],
"_agentAssigned": [],
"segments": [],
"applicableFilters": ["userInteracted"],
"lastSeenAt": {
"startAt": "",
"endsAt": ""
},
"createdAt": {
"startAt": "",
"endsAt": ""
},
"userInteracted": true,
"lastMessageBy": [],
"isLiveChatActive": false,
"hasOrdered": {
"status": false,
"lastAt": ""
},
"page": 1,
"isExport": "none",
"isContact": true
}'
--compressed❓ Got any questions?
If you have any questions, you can look into our repository of FAQs, most likely, you will find your answer here, If not, write us at production@S10U.co.za.