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

# List customer lists

> Returns your customer lists, newest first, one page at a time, with contact counts for each.

Each list has the fields described in [Customer list fields](https://docs.olimi.ai/api-reference/endpoint/customer-list/customer-lists.md#customer-list-fields). The list doesn't include each list's variants; use [Get a customer list](https://docs.olimi.ai/api-reference/endpoint/customer-list/get-customer-list.md) for those.

Use `meta.totalPages` to know when you've fetched every page.

`page` and `limit` must be positive whole numbers. Zero or a negative number returns `400` `failed_update_data`, and a value that isn't a number causes a server error.


## OpenAPI

````yaml get /api/v2/customer-lists
openapi: 3.0.1
info:
  title: Customer Management API
  description: API for managing customer lists and customers within those lists
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api-eg.olimi.ai
security:
  - bearerAuth: []
paths:
  /api/v2/customer-lists:
    get:
      tags:
        - Customer Lists
      summary: List customer lists
      description: >-
        Returns your customer lists, newest first, one page at a time, with
        contact counts for each.
      parameters:
        - name: page
          in: query
          required: false
          description: Page number, a positive whole number. Defaults to `1`.
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          required: false
          description: Customer lists per page, a positive whole number. Defaults to `10`.
          schema:
            type: integer
            default: 10
        - name: search
          in: query
          required: false
          description: Matches lists whose name contains the text. Not case-sensitive.
          schema:
            type: string
      responses:
        '200':
          description: A page of customer lists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerListListResponse'
        '400':
          description: >-
            `failed_update_data`: `page` or `limit` is zero or negative. A value
            that isn't a number causes a 500 error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: The `X-API-KEY` header is missing or the key isn't valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - apiKeyAuth: []
components:
  schemas:
    CustomerListListResponse:
      type: object
      properties:
        message:
          type: string
          example: Customers fetched successfully
        meta:
          $ref: '#/components/schemas/PaginationMeta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomerListSummary'
    ApiError:
      type: object
      properties:
        statusCode:
          type: integer
          example: 404
        errorCode:
          type: string
          description: Machine-readable error code.
          example: agent_not_found
        message:
          type: string
          description: Human-readable text. May change; don't match on it.
          example: Agent not found
    PaginationMeta:
      type: object
      properties:
        totalItems:
          type: integer
          description: Total items across all pages.
          example: 12
        itemCount:
          type: integer
          description: Items on this page.
          example: 10
        itemsPerPage:
          type: integer
          description: The `limit` used.
          example: 10
        totalPages:
          type: integer
          description: Number of pages.
          example: 2
        currentPage:
          type: integer
          description: The `page` returned.
          example: 1
    CustomerListSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The customer list's ID.
          example: 9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24
        organizationId:
          type: string
          format: uuid
          description: Your company's ID.
          example: 5f2c8a91-7d3e-4b60-8c1a-9e4f2b7d6a35
        name:
          type: string
          description: The list's name.
          example: September renewals
        allowDuplication:
          type: boolean
          nullable: true
          description: >-
            Whether the list accepts a phone number more than once. `null` means
            no.
          example: false
        totalContacts:
          type: integer
          description: Contacts in the list.
          example: 1240
        createdAt:
          type: string
          format: date-time
          description: When the list was created (UTC).
          example: '2026-09-20T08:02:11.904Z'
        updatedAt:
          type: string
          format: date-time
          description: When the list was last changed (UTC).
          example: '2026-09-20T08:02:11.904Z'
        answeredCount:
          type: integer
          description: Contacts in the list who answered at least one campaign call.
          example: 512
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.