- Documentation
- Sandbox
Documentation
Get all user chats.
Filters
Name | Information | ||||||
---|---|---|---|---|---|---|---|
status |
|
||||||
page |
|
||||||
limit |
|
||||||
orderBy |
|
||||||
voice |
|
||||||
flat |
|
||||||
unread |
|
||||||
pinned |
|
Return
Parameter | Type | Versions | Description |
---|---|---|---|
id | integer | * | |
originalId | integer | * | |
phone | string | * | |
contact | object (Contact) | * | |
contact[favorited] | boolean | * | |
contact[id] | integer | * | |
contact[firstName] | string | * | |
contact[lastName] | string | * | |
contact[companyName] | string | * | |
contact[phone] | string | * | |
contact[email] | string | * | |
contact[country] | object (Country) | * | |
contact[country][id] | string | * | |
contact[country][name] | string | * | |
contact[customFields][] | array of objects (ContactCustomField) | * | |
contact[customFields][][id] | integer | * | |
contact[customFields][][name] | string | * | |
contact[customFields][][createdAt] | DateTime | * | |
contact[user] | object (User) | * | |
contact[user][displayTimeFormat] | string | * | |
contact[user][id] | integer | * | |
contact[user][username] | string | * | |
contact[user][firstName] | string | * | |
contact[user][lastName] | string | * | |
contact[user][email] | string | * | |
contact[user][status] | string | * | |
contact[user][balance] | double | * | |
contact[user][phone] | string | * | |
contact[user][company] | string | * | |
contact[user][currency] | object (Currency) | * | |
contact[user][currency][unicodeSymbol] | string | * | |
contact[user][currency][id] | string | * | |
contact[user][currency][htmlSymbol] | string | * | |
contact[user][country] | object (Country) | * | |
contact[user][timezone] | object (Timezone) | * | |
contact[user][timezone][id] | integer | * | |
contact[user][timezone][area] | string | * | |
contact[user][timezone][dst] | integer | * | |
contact[user][timezone][offset] | integer | * | |
contact[user][timezone][timezone] | string | * | |
contact[user][subaccountType] | string | * | |
contact[user][emailAccepted] | boolean | * | |
contact[user][phoneAccepted] | boolean | * | |
contact[user][avatar] | object (UserImage) | * | |
contact[user][avatar][href] | string | * | |
contact[lists][] | array of objects (Group) | * | |
contact[lists][][favorited] | boolean | * | |
contact[lists][][id] | integer | * | |
contact[lists][][name] | string | * | |
contact[lists][][description] | string | * | |
contact[lists][][membersCount] | integer | * | |
contact[lists][][user] | object (User) | * | |
contact[lists][][service] | boolean | * | |
contact[lists][][shared] | boolean | * | |
contact[lists][][avatar] | object (GroupImage) | * | |
contact[lists][][avatar][href] | string | * | |
contact[lists][][isDefault] | boolean | * | |
contact[phoneType] | string | * | |
contact[avatar] | object (ContactImage) | * | |
contact[avatar][href] | string | * | |
contact[notes][] | array of objects (ContactNote) | * | |
contact[notes][][id] | integer | * | |
contact[notes][][createdAt] | DateTime | * | |
contact[notes][][note] | string | * | |
contact[notes][][user] | object (User) | * | |
unsubscribedContactId | integer | * | |
unread | integer | * | |
updatedAt | DateTime | * | |
status | string | * | |
mute | integer | * | |
lastMessage | string | * | |
direction | string | * | |
from | string | * | |
mutedUntil | DateTime | * | |
timeLeftMute | integer | * | |
pinned | boolean | * | |
country | object (Country) | * | |
country[id] | string | * | |
country[name] | string | * |
Status Codes
Status Code | Description |
---|---|
200 |
|