Skip to main content
GET
/
api
/
v1
/
collections
/
{collectionId}
Get Collection By ID
curl --request GET \
  --url https://api.zixflow.com/api/v1/collections/{collectionId}
{   
    "status": true,
    "message": "Collection fetched successfully",
    "data": {
        "_id": "652e506bf781c59be3825523",
        "collectionType": "people",
        "name": "People",
        "slug": "people"
    }
}

​
Path Params

​
collectionId
string
required
A unique identifier for the list, allowing for precise referencing.

​
API Response Description:

Upon querying your collection endpoint, the API returns a structured response containing information about the requested collection. 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
object
An Object containing details of the available collections.
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. 
{   
    "status": true,
    "message": "Collection fetched successfully",
    "data": {
        "_id": "652e506bf781c59be3825523",
        "collectionType": "people",
        "name": "People",
        "slug": "people"
    }
}