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

# List advanced customer records

> Requires contacts:read, deals:read and Customer CDP. Filters and returned private-inbox facts are limited by the API key owner's current workspace access.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/accounts/{accountId}/cdp/customers
openapi: 3.0.3
info:
  contact:
    name: HueChat support
    email: support@huechat.ai
    url: https://huechat.ai/contact
  description: >-
    Account-scoped REST API for HueChat: conversations, messages, contacts,
    inboxes, teams, agents, AI agents and knowledge, WhatsApp templates and
    broadcasts, workflows, chat menus, appointments and webhooks, authenticated
    with account-scoped API keys. Every route is scoped to your own account.
  license:
    name: Proprietary
    url: https://huechat.ai/terms
  termsOfService: https://huechat.ai/terms
  title: HueChat API
  version: 2.0.0
servers:
  - url: https://app.huechat.ai
    description: Production
security:
  - bearerAuth: []
tags:
  - name: AI Agents
    description: >-
      Assistants you build to answer customers on their own: persona, language,
      guardrails, tools and a knowledge base, published to inboxes, replying in
      Arabic or English until they hand off to a human. Create, publish, test,
      monitor quality and roll back versions.
  - name: Agents
    description: The human agents on your account and their availability.
  - name: Broadcasts
    description: >-
      Send a WhatsApp template to a list of contacts from a CSV or saved
      audience, with scheduling, pause and resume, and delivery reports.
  - name: Chat Menus
    description: >-
      Numbered or button-driven menus a customer sees at the start of a
      conversation.
  - name: Contacts
    description: >-
      The people your team talks to: phone, email, name, custom attributes,
      labels and notes. One contact can have conversations on several channels.
  - name: Conversations
    description: >-
      A conversation is one thread between a contact and your team on one
      channel, with status, assignee, team, labels, priority and custom
      attributes. List, filter, search, assign, resolve and annotate them.
  - name: Inboxes
    description: >-
      Connected channels: a WhatsApp Business number, an Instagram or Messenger
      page, an email address or a website live-chat widget. Inboxes decide where
      a conversation comes from and who can see it.
  - name: Knowledge
    description: >-
      Documents, web pages and text that ground an AI agent's answers. Upload,
      point at a URL or paste text; HueChat indexes it and the agent cites it.
  - name: Messages
    description: >-
      Everything said inside a conversation: text, attachments, WhatsApp
      templates and interactive replies. Sending through the API delivers on the
      conversation's channel and shows in the inbox like any agent reply.
  - name: Outbound Webhooks
    description: >-
      Signed webhooks (v2): HMAC-SHA256 signature on every delivery, test
      events, delivery logs and secret rotation.
  - name: Teams
    description: Groups of agents used for assignment and reporting.
  - name: Templates
    description: >-
      Pre-approved WhatsApp message formats required by Meta for
      business-initiated messages. Create, sync from Meta, AI-generate,
      test-send and read analytics.
  - name: Webhooks
    description: >-
      Account webhooks (v1): a URL plus event subscriptions, as configured in
      the dashboard. Unsigned; prefer Outbound Webhooks for new integrations.
  - name: Workflows
    description: >-
      Automation flows built from triggers and steps: route, tag, reply, wait,
      hand off. Create, publish, version and toggle.
paths:
  /api/v2/accounts/{accountId}/cdp/customers:
    get:
      tags:
        - Customer CDP
      summary: List advanced customer records
      description: >-
        Requires contacts:read, deals:read and Customer CDP. Filters and
        returned private-inbox facts are limited by the API key owner's current
        workspace access.
      parameters:
        - description: HueChat account ID
          name: accountId
          in: path
          required: true
          schema:
            type: integer
        - description: Search name, email, phone, identifier and company
          name: q
          in: query
          schema:
            type: string
        - description: Comma-separated contact IDs; maximum 100
          name: ids
          in: query
          schema:
            type: string
        - description: Customer view
          name: view
          in: query
          schema:
            type: string
            enum:
              - all
              - members
              - attention
        - description: Source kind
          name: source
          in: query
          schema:
            type: string
        - description: Label
          name: label
          in: query
          schema:
            type: string
        - description: Company
          name: company
          in: query
          schema:
            type: string
        - description: Location
          name: location
          in: query
          schema:
            type: string
        - description: Phone presence
          name: phone
          in: query
          schema:
            type: string
            enum:
              - all
              - present
              - missing
        - description: Email presence
          name: email
          in: query
          schema:
            type: string
            enum:
              - all
              - present
              - missing
        - description: Sort field
          name: sort
          in: query
          schema:
            type: string
        - description: Page number
          name: page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100000
        - description: Records per page
          name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.CDPAPIError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.CDPAPIError'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.CDPAPIError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.CDPAPIError'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/huechat.CDPAPIError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    huechat.CDPAPIError:
      type: object
      properties:
        code:
          type: string
          example: plan_disabled
        error:
          type: string
          example: Record not found or unavailable
        feature:
          type: string
          example: customer_cdp
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your personal access token from Settings → Profile, or a scoped API key
        (`hc_…`) created at Settings → Developer → API keys. Send it as
        `Authorization: Bearer <token>`.

````