> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zixflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get List Of Collections

> Lists all system and custom collections of your workspace.

#### 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:

<ResponseField name="status" type="boolean">
  Indicates the success or failure of the collection retrieval. In this case,
  true signifies a successful operation.
</ResponseField>

<ResponseField name="message" type="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."
</ResponseField>

<ResponseField name="data" type="array_object">
  An array containing details of the available collections. For each collection
  in the data array:

  <Expandable title="data">
    <ResponseField name="_id" type="string">
      A unique identifier for the collection, allowing for precise referencing.
    </ResponseField>

    <ResponseField name="name" type="string">
      The human-readable name of the collection, providing a clear
      identification.
    </ResponseField>

    <ResponseField name="slug" type="string">
      A unique identifier for the collection, useful for programmatic
      identification and differentiation.
    </ResponseField>

    <ResponseField name="collectionType" type="string">
      Specifies the type of the collection. For system-defined collections, it
      will have values like "people," "company," or "deals." For user-defined
      collections, it will return "custom."
    </ResponseField>
  </Expandable>
</ResponseField>

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.

<ResponseExample>
  ```json 200-Success theme={null}
  {
    "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"
      }
    ]
  }
  ```

  ```json 401-Unauthorised theme={null}
  {
    "status": false,
    "message": "No token provided"
  }
  ```
</ResponseExample>