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

> This endpoint returns all lists

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

<ResponseField name="status" type="boolean">
  Indicates the success or failure of the list 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 list with the message
  "List fetched successfully."
</ResponseField>

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

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

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

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

    <ResponseField name="emoji" type="string">
      An emoji associated with the list for visual identification.
    </ResponseField>

    <ResponseField name="collectionId" type="string">
      The unique identifier of the collection to which the list belongs,
      facilitating collection identification.
    </ResponseField>

    <ResponseField name="duplicationAllowed" type="boolean">
      Defines whether duplicate records can be added inside the list.
    </ResponseField>

    <ResponseField name="collection" type="object">
      Details about the collection from which the list is created:

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

        <ResponseField name="collectionType" type="string">
          Specifies the type of the collection, such as "people," "company," or "deals."
        </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>
      </Expandable>
    </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 list endpoint.

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

  ```

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