GET
/
api
/
v1
/
lists
Authorization
curl --request GET \
  --url https://api.zixflow.com/api/v1/lists \
  --header 'Authorization: <authorization>'
{
  "status": true,
  "message": "List fetched successfully.",
  "data": [
    {
      "_id": "653bbba76ecd501e8dcbbb5d",
      "name": "Alumni",
      "slug": "Alumni",
      "emoji": "🚀",
      "collectionId": "652e506bf781c59be3825523",
      "duplicationAllowed": true,
      "collection": {
        "_id": "652e506bf781c59be3825523",
        "collectionType": "people",
        "name": "People",
        "slug": "people"
      }
    }
  ]
}

​
API Response Description:

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

status
boolean

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

data
array_object

An array containing details of the available lists. For each list 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 list endpoint.

Get Collection By IDGet List By ID