- Zixflow Web
- Help Center
- Blog
- Introduction
- GETGet List Of WA Accounts
- GETGet List Of Templates
- GETGet Template Variables
- POSTSend Whatsapp Template Message
- POSTSend Whatsapp Text Message
- POSTSend Whatsapp Image Message
- POSTSend Whatsapp Video Message
- POSTSend Whatsapp Audio Message
- POSTSend Whatsapp Document Message
- POSTSend Whatsapp Location Message
Attribute Options
Attribute Status
- GETGet List Of Attributes
- GETGet Attribute By ID
- POSTCreate Custom Attribute
- PATCHUpdate Custom Attribute
- DELDelete Custom Attribute
- POSTGet List of Collection Records
- GETGet Collection Record By ID
- POSTCreate A Collection Record
- PATCHUpdate A Collection Record
- DELDelete Collection Record By ID
- POSTGet List of List Entries
- GETGet List Entry By ID
- POSTCreate A List Entry
- PATCHUpdate List Entry
- DELDelete List Entry By ID
Whatsapp Campaign
Attributes
Collection Records
List Entries
Get List By ID
This endpoint returns a list
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
A unique identifier for the list, allowing for precise referencing.
curl --request GET \
--url https://api.zixflow.com/api/v1/lists/{listId} \
--header 'Authorization: Bearer <token>'
{
"status": true,
"message": "Collection fetched successfully",
"data": {
"_id": "653bbba76ecd501e8dcbbb5d",
"name": "Alumni",
"slug": "Alumni",
"emoji": "🚀",
"collectionId": "652e506bf781c59be3825523",
"duplicationAllowed": true,
"collection": {
"_id": "652e506bf781c59be3825523",
"collectionType": "people",
"name": "People",
"slug": "people"
}
}
}
Path Params
A unique identifier for the list, allowing for precise referencing.
API Response Description:
Indicates the success or failure of the list retrieval. In this case, true signifies a successful operation.
Provides a human-readable message accompanying the response. In this instance, it confirms the successful retrieval of the list with the message “List fetched successfully.”
Detailed information about the selected List:
A unique identifier for the list, allowing for precise referencing.
The human-readable name of the list, providing a clear identification.
A unique identifier for the list, useful for programmatic identification and differentiation.
An emoji associated with the list for visual identification.
The unique identifier of the collection to which the list belongs, facilitating collection identification.
Defines whether duplicate records can be added inside the list.
Details about the collection from which the list is created:
A unique identifier for the collection, allowing for precise referencing.
Specifies the type of the collection, such as “people,” “company,” or “deals.”
The human-readable name of the collection, providing a clear identification.
A unique identifier for the collection, useful for programmatic identification and differentiation.
curl --request GET \
--url https://api.zixflow.com/api/v1/lists/{listId} \
--header 'Authorization: Bearer <token>'
{
"status": true,
"message": "Collection fetched successfully",
"data": {
"_id": "653bbba76ecd501e8dcbbb5d",
"name": "Alumni",
"slug": "Alumni",
"emoji": "🚀",
"collectionId": "652e506bf781c59be3825523",
"duplicationAllowed": true,
"collection": {
"_id": "652e506bf781c59be3825523",
"collectionType": "people",
"name": "People",
"slug": "people"
}
}
}