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

​
Path Params

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

​
API Response Description:

​
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
object
Detailed information about the selected List:
{   
    "status": true,
    "message": "Collection fetched successfully",
    "data": {
      "_id": "653bbba76ecd501e8dcbbb5d",
      "name": "Alumni",
      "slug": "Alumni",
      "emoji": "🚀",
      "collectionId": "652e506bf781c59be3825523",
      "duplicationAllowed": true,
      "collection": {
        "_id": "652e506bf781c59be3825523",
        "collectionType": "people",
        "name": "People",
        "slug": "people"
      }
    }
}