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

# Get Customers

> Returns all customers using pagination



## OpenAPI

````yaml POST /customers
openapi: 3.1.0
info:
  title: Pingmee API
  description: A complete guide to Pingmee micro service architecture.
  version: 1.0.0
servers:
  - url: https://api.pingmee.co.il
security:
  - cookieAuth: []
    ApiKeyAuth: []
paths:
  /customers:
    servers:
      - url: https://campaigns.pingmee.co.il
        description: Campaigns service
    post:
      description: Returns all customers using pagination
      requestBody:
        description: >-
          Optionally provide pagination parameters to retrieve the next page of
          customers.
        content:
          application/json:
            schema:
              type: object
              properties:
                lastEvaluatedKey:
                  type: object
                  description: >-
                    Key returned from the previous request. Pass this value to
                    fetch the next page of results.
                  additionalProperties: false
                limit:
                  type: number
                  default: 25
                  minimum: 1
                  maximum: 100
                  description: Maximum number of customers to return.
        required: false
      responses:
        '200':
          description: Customers
          content:
            application/json:
              schema:
                type: object
                properties:
                  customers:
                    type: array
                    description: List of customers returned for this page of results.
                    items:
                      $ref: '#/components/schemas/Customer'
                  hasMoreItemsToFetch:
                    type: boolean
                  lastEvaluatedKey:
                    type: object
                    description: >-
                      If present, call the same endpoint again and pass this
                      value as `lastEvaluatedKey` to retrieve the next page of
                      results. Pagination is cursor-based, not page-number
                      based.
                    additionalProperties: false
        '400':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Customer:
      type: object
      required: []
      properties:
        profileImage:
          type:
            - string
            - 'null'
          description: Profile image URL if available
        customerName:
          type: string
          description: The name from WhatsApp or the originating platform
        customerNickname:
          type: string
          description: The name the business gave the customer
        description:
          type: string
          description: >-
            Free-text note / description controlled by the business (shown in
            the conversation sidebar)
        createdAt:
          type: number
          description: Unix timestamp (milliseconds) when the customer was created
        lastActiveAt:
          type: number
          description: Unix timestamp (milliseconds) when the customer was last active
        email:
          type: string
          format: email
          description: Customer email address
        platform:
          type: string
          enum:
            - whatsapp
            - instagram
            - facebookMessenger
          description: Messaging platform the customer is associated with
        phoneNumberId:
          type: string
          description: Platform-specific phone number identifier
        countryCode:
          type: string
          description: Country calling code
        associatedTo:
          type: string
          description: Business or account the customer is associated with
        parsedPhoneNumber:
          type: string
          description: Normalized phone number if available
      additionalProperties: false
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: header
      name: Cookie
      description: Personal access token from Pingmee Settings → Developer Tools
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Business API key from Pingmee Settings → Developer Tools

````