GET
/
api
/
v1
/
collections
curl --request GET \
  --url https://api.zixflow.com/api/v1/collections \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "message": "Collection fetched successfully",
  "data": [
    {
      "_id": "652e506bf781c59be3825523",
      "collectionType": "people",
      "name": "People",
      "slug": "people"
    },
    {
      "_id": "652e506bf781c59be3825526",
      "collectionType": "company",
      "name": "Company",
      "slug": "company"
    },
    {
      "_id": "652e506bf781c59be3825528",
      "collectionType": "deals",
      "name": "Deals",
      "slug": "deals"
    }
  ]
}

​
API Response Description:

Upon querying your collection endpoint, the API returns a structured response containing information about the available collections. Here’s a breakdown of the response:

​
status
boolean

Indicates the success or failure of the collection 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 the collection with the message “Collection fetched successfully.”

​
data
array_object

An array containing details of the available collections. For each collection in the data array:

This structured response aims to offer clarity and ease of interpretation, enabling developers and users to effectively understand and utilize the information retrieved from the collection endpoint.