- 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 Activity By Id
This endpoint returns all activity data
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
A unique identifier for the activity data.
curl --request GET \
--url https://api.zixflow.com/api/v1/collection-records/activity-list/{activityId} \
--header 'Authorization: Bearer <token>'
{
"status": true,
"message": "Records fetched successfully",
"data": {
"_id": "654b3231448888ff7d161a59",
"name": "Call HOH",
"scheduleAt": "2023-11-08T07:01:00.000Z",
"description": "",
"associated": null,
"assignee": {
"_id": "65338d9a4d3b7a624a8d63ab",
"name": "Test User",
"avatar": "",
"email": "user@zixflow.com"
},
"status": {
"_id": "65338d9cf781c59be3859c63",
"color": "#99ff93",
"name": "Completed",
"celebrationEnabled": false,
"isArchived": false,
"order": 2,
"statusType": "normal",
"timeInStatus": 0
},
"sourceDetails": "",
"source": {
"_id": "65338d9cf781c59be3859c6a",
"name": "Manually created",
"color": "#efe0da",
"isArchived": false,
"order": 1
},
"createdBy": {
"_id": "65338d9a4d3b7a624a8d63ab",
"name": "Test User",
"avatar": "",
"email": "user@zixflow.com"
},
"completedTime": "2023-11-08T07:01:30.450Z",
"activityLostReason": null,
"createdAt": "2023-11-08T07:01:05.770Z"
}
}
Path
A unique identifier for the activity data.
Response
Indicates the success or failure of the record 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 records with the message “Records fetched successfully.”
An array containing details of the fetched records. For each record in the data array:
A unique identifier for the record, allowing for precise referencing.
The name associated with the record.
The scheduled time for the record in ISO 8601 format.
Additional information or details about the record.
Details about any associated entity, if applicable.
Details about the assignee of the record:
Unique identifier for the assignee.
The name of the assignee.
URL or information about the assignee’s avatar.
Email address of the assignee.
Details about the status of the record:
Unique identifier for the status.
Hex color code representing the status color.
The name of the status.
Additional details about the source of the record.
Details about the source of the record:
Unique identifier for the source.
The name of the source.
Hex color code representing the source color.
Details about the creator of the record:
Unique identifier for the creator.
The name of the creator.
URL or information about the creator’s avatar.
Email address of the creator.
The timestamp when the record was completed in ISO 8601 format.
Reason for any lost activity, if applicable.
The timestamp when the record was created in ISO 8601 format.
curl --request GET \
--url https://api.zixflow.com/api/v1/collection-records/activity-list/{activityId} \
--header 'Authorization: Bearer <token>'
{
"status": true,
"message": "Records fetched successfully",
"data": {
"_id": "654b3231448888ff7d161a59",
"name": "Call HOH",
"scheduleAt": "2023-11-08T07:01:00.000Z",
"description": "",
"associated": null,
"assignee": {
"_id": "65338d9a4d3b7a624a8d63ab",
"name": "Test User",
"avatar": "",
"email": "user@zixflow.com"
},
"status": {
"_id": "65338d9cf781c59be3859c63",
"color": "#99ff93",
"name": "Completed",
"celebrationEnabled": false,
"isArchived": false,
"order": 2,
"statusType": "normal",
"timeInStatus": 0
},
"sourceDetails": "",
"source": {
"_id": "65338d9cf781c59be3859c6a",
"name": "Manually created",
"color": "#efe0da",
"isArchived": false,
"order": 1
},
"createdBy": {
"_id": "65338d9a4d3b7a624a8d63ab",
"name": "Test User",
"avatar": "",
"email": "user@zixflow.com"
},
"completedTime": "2023-11-08T07:01:30.450Z",
"activityLostReason": null,
"createdAt": "2023-11-08T07:01:05.770Z"
}
}