Body
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.
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.
he number of records to be returned, set to 10 in this instance. This
parameter restricts the response to a specific quantity of records.
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
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.
Additional details about the source of the record.
Details about the source of the record: Unique identifier for the source.
Hex color code representing the source color.
Details about the creator of the record: Unique identifier for 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.
200-Success
401-Unauthorised
{
"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"
}
]
}