> ## Documentation Index
> Fetch the complete documentation index at: https://help.commbox.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Stream Objects
> 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.
## OpenAPI
````json GET /streams/{STREAM_ID}/objects
{
"openapi": "3.0.3",
"info": {
"title": "CommBox API",
"x-logo": {
"url": "https://www.commbox.io/logo/commbox_logo_large.png"
},
"version": "2.07",
"termsOfService": "https://www.commbox.io/end-user-license-agreement-eula/",
"contact": {
"name": "commbox",
"url": "https://www.commbox.io",
"email": "contactus@commbox.io"
}
},
"servers": [
{
"url": "https://api.commbox.io/",
"description": "Production server"
}
],
"security": [
{
"BearerAuth": []
}
],
"tags": [
{
"name": "Core",
"description": "
Systemwide verification"
},
{
"name": "Objects",
"description": "
Objects are conversations between the AI Agent or the human agent and the customers, where each segment of the conversation is referred to as a Child. Every conversation must have a designated Stream – a communication channel such as Chat, Email, Text/SMS, etc., through which the conversation takes place.
The Object APIs category concentrates on a specific conversation, where the Stream is part of the identifying parameters. In contrast, the Streams APIs category, the Channel is the focal point of the request, and the objects and users are the filtering aspects."
},
{
"name": "Media",
"description": "Converting media files to Base64"
},
{
"name": "AI Services",
"description": "APIs that provide AI capabilities by the platform. "
},
{
"name": "Streams",
"description": "
Streams are communication channels used in CommBox, such as Chat, WhatsApp, SMS/Text, etc. In the Streams category of APIs, the channel is the focal point of the request, and the objects and users are the filtering aspects. See the Enums Section for available channels and their CommBox code."
},
{
"name": "Tags",
"description": "
Tags are a classification tool for summarizing aspects of the conversation or the user. It can mark the conversation to indicate a new sale or identify a customer as not interested in the product. To help manage the Tags assets, Tags can be grouped with a common identifier."
},
{
"name": "SMS",
"description": "
Sending customers **SMS messages** (Texting) requires an initial opt-in step, which is not offered by CommBox and is the sole responsibility of the sending entity (Business)."
},
{
"name": "WhatsApp",
"description": "
CommBox facilitates activities in **WABA** for the clients. Our platform helps clients create new templates and manage existing ones.
**Opt-in for WhatsApp**
Before sending WhatsApp messages to someone, you must first receive opt-in permission confirming that they wish to receive future messages from you on WhatsApp. This can be done using any channel your business uses to communicate with people — your website, app, email, retail location, etc.