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

# Get a customer list

> Returns one customer list with its contact count and custom columns (variants).

It doesn't return the contacts themselves; use [List contacts](https://docs.olimi.ai/api-reference/endpoint/contacts/list-contacts.md) for those. For what variants are and how they're used, see [Variants](https://docs.olimi.ai/api-reference/endpoint/customer-list/customer-lists.md#variants).


## OpenAPI

````yaml get /api/v2/customer-lists/{id}
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/{id}:
    get:
      tags:
        - Customer Lists
      summary: Get a customer list
      description: >-
        Returns one customer list with its contact count and custom columns
        (variants).
      parameters:
        - name: id
          in: path
          required: true
          description: The customer list's `id`.
          schema:
            type: string
            format: uuid
          example: 9c4e1b7a-2d5f-4a83-b6e0-3f7d9a1c5e24
      responses:
        '200':
          description: The customer list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerListResponse'
        '400':
          description: '`id` isn''t a valid UUID.'
        '401':
          description: The `X-API-KEY` header is missing or the key isn't valid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            `customer_not_found`: no customer list with that `id` belongs to
            your company, or it was deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - apiKeyAuth: []
components:
  schemas:
    CustomerListResponse:
      type: object
      properties:
        message:
          type: string
          example: Customer fetched successfully
        data:
          $ref: '#/components/schemas/CustomerList'
    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
    CustomerList:
      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'
        variants:
          type: array
          description: The list's custom columns.
          items:
            $ref: '#/components/schemas/CustomerListVariant'
    CustomerListVariant:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: >-
            The variant's ID. Send it as `variantId` when adding or editing
            contacts.
          example: 7e3c9b15-6a2d-4f8e-b1c4-5d9a3e7f2b60
        slug:
          type: string
          description: >-
            The name the agent's script uses, for example `order_number` in
            `{{order_number}}`.
          example: order_number
        name:
          type: string
          description: The column's display name.
          example: Order number
        createdAt:
          type: string
          format: date-time
          description: When the variant was created (UTC).
          example: '2026-09-20T08:02:11.904Z'
        updatedAt:
          type: string
          format: date-time
          description: When the variant was last changed (UTC).
          example: '2026-09-20T08:02:11.904Z'
  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.