This API returns information about all Objects (conversations) in the requested Stream (channel).
Required query params:
Use query params to limit the request. Without limiting the request, the call will fail. See below common options.
a) Time range - For all Objects within a range of time:
- unixStartTime – Unix Time Stamp format for start time
- unixEndTime – Unix Time Stamp format for end time
- Max: 100 objects – for larger data additional calls are required
b) Specific user - For all Objects of a specific user:
- identityStreamProviderId – found in the "identities" section of the Get Users API (streamProviderId field)
- identityStreamProviderType – found in the "identities" section of the Get Users API (StreamProviderType field)
c) Specific user (alternative method) - For all Objects of a specific user:
- userIdentityId – the Id of the identity as it appears in the Get Users API (not to be confused with the "userId" field)
d) Last WhatsApp message (WA channel ID in Path):
- streamProviderId – enter the international format of customer's phone number
- streamProviderType – enter 5
- status – enter 1,8 to filter the result by object status (1 - New and 8 - Pending, representing active, unassigned, or in-progress conversations)
- To ensure only the most recent relevant record is returned set pageNumber to 0, pageSize to 1, and sort to
desc
Use the optional parameters to limit and organize the output.
Note: Object's children and activity logs are False by default.
API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call.
For additional support you can contact us.
A CommBox generated number for the channel
A CommBox generated number for the user. Returns objects created by this user
To returns objects created by a user, enter the StreamProviderId found at the identity section. Must supply identityStreamProviderType as well.
See Enum. To returns objects created by a user, enter the StreamProviderType found at the identity section. Must supply identityStreamProviderId as well.
Unix time stamp (UTC) of starting date and time of query.
Must be sent with unixEndTime
Unix time stamp (UTC) of ending date and time of query.
Must be sent with unixStartTime
The subchannel Id (Optional, default 0)
Sort of return objects (optional, default desc). Possible values: desc, asc
Order of return objects (optional, default createdtime). Possible values: createdtime, closedtime, prioritytime, updatedtime
Return objects with their childs (optional, default false)
Return objects with their activity log (optional, default false)
Determines which object datetime field affects unixStartTime & unixEndTime (optional, relevant only for ElasticSearch)
Used for paging results (optional)
Used for paging results (optional, default 100)
ObjectStatusType - see Enums for code.
Returned objects must have selected statuses in a comma separated list
(Optional, default all)
OK
JSON string containing metadata
number of listings for the user
system remarks
true = agent , false = customer
Bad Request - The request could not be understood by the server. Incoming parameters might not be valid
Unauthorized - The supplied credentials, if any, are not sufficient to access the resource
Not Found - The requested resource is not found
Too Many Requests - Too many requests have been made in a short period of time (Throttling)
Internal Server Error - The server could not return the representation due to an internal server error
{
"status": 500,
"description": "Operation failed",
"response_time": "2025-04-15T07:24:52.956Z"
}