Get Activity By Id
curl --request GET \
--url https://api.zixflow.com/api/v1/collection-records/activity-list/{activityId}{
"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"
}
}
Activity / Task
Get Activity By Id
This endpoint returns all activity data
GET
/
api
/
v1
/
collection-records
/
activity-list
/
{activityId}
Get Activity By Id
curl --request GET \
--url https://api.zixflow.com/api/v1/collection-records/activity-list/{activityId}{
"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:
Show data
Show data
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.
Additional details about the source of the record.
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.
{
"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"
}
}
⌘I