Skip to main content
POST
https://api.zixflow.com
/
api
/
v1
/
collection-records
/
activity-list
/
query
Get List of Activities
curl --request POST \
  --url https://api.zixflow.com/api/v1/collection-records/activity-list/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": [
    {}
  ],
  "sort": [
    {}
  ],
  "limit": 123,
  "offset": 123
}
'
{
    "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": "[email protected]"
            },
            "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": "[email protected]"
            },
            "completedTime": "2023-11-08T07:01:30.450Z",
            "activityLostReason": null,
            "createdAt": "2023-11-08T07:01:05.770Z"
        }
    ]
}

​
Body

​
filter
array
An array that will eventually allow users to define specific criteria for filtering data. Currently, it is an empty array, indicating that no filtering is applied at this time.
​
sort
array
An array that will eventually enable users to specify sorting criteria for the data. Like the filter array, it is currently empty, implying that no sorting is applied in the current context.
​
limit
number
required
he number of records to be returned, set to 10 in this instance. This parameter restricts the response to a specific quantity of records.
​
offset
number
required
The starting point from which the records are to be fetched within the entire dataset. In this case, it is set to 0, indicating that retrieval should commence from the beginning of the dataset.

​
Response

​
status
boolean
Indicates the success or failure of the record retrieval. In this case, true signifies a successful operation.
​
message
string
Provides a human-readable message accompanying the response. In this instance, it confirms the successful retrieval of records with the message “Records fetched successfully.”
​
data
array_object
An array containing details of the fetched records. For each record in the data array:
{
    "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": "[email protected]"
            },
            "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": "[email protected]"
            },
            "completedTime": "2023-11-08T07:01:30.450Z",
            "activityLostReason": null,
            "createdAt": "2023-11-08T07:01:05.770Z"
        }
    ]
}