# Source: https://dub.co/docs/api-reference/endpoint/retrieve-a-list-of-customers.md

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

# List all customers

> Retrieve a list of customers for the authenticated workspace.



## OpenAPI

````yaml get /customers
openapi: 3.0.3
info:
  title: Dub API
  description: >-
    Dub is the modern link attribution platform for short links, conversion
    tracking, and affiliate programs.
  version: 0.0.1
  contact:
    name: Dub Support
    email: support@dub.co
    url: https://dub.co/api
  license:
    name: AGPL-3.0 license
    url: https://github.com/dubinc/dub/blob/main/LICENSE.md
servers:
  - url: https://api.dub.co
    description: Production API
security: []
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: Retrieve a list of customers
      description: Retrieve a list of customers for the authenticated workspace.
      operationId: getCustomers
      parameters:
        - in: query
          name: email
          schema:
            description: >-
              A case-sensitive filter on the list based on the customer's
              `email` field. The value must be a string. Takes precedence over
              `externalId`.
            type: string
          description: >-
            A case-sensitive filter on the list based on the customer's `email`
            field. The value must be a string. Takes precedence over
            `externalId`.
        - in: query
          name: externalId
          schema:
            description: >-
              A case-sensitive filter on the list based on the customer's
              `externalId` field. The value must be a string. Takes precedence
              over `search`.
            type: string
          description: >-
            A case-sensitive filter on the list based on the customer's
            `externalId` field. The value must be a string. Takes precedence
            over `search`.
        - in: query
          name: search
          schema:
            description: >-
              A search query to filter customers by email, externalId, or name.
              If `email` or `externalId` is provided, this will be ignored.
            type: string
          description: >-
            A search query to filter customers by email, externalId, or name. If
            `email` or `externalId` is provided, this will be ignored.
        - in: query
          name: country
          schema:
            description: A filter on the list based on the customer's `country` field.
            type: string
          description: A filter on the list based on the customer's `country` field.
        - in: query
          name: linkId
          schema:
            description: >-
              A filter on the list based on the customer's `linkId` field (the
              referral link ID).
            type: string
          description: >-
            A filter on the list based on the customer's `linkId` field (the
            referral link ID).
        - in: query
          name: programId
          schema:
            description: Program ID to filter by.
            type: string
          description: Program ID to filter by.
        - in: query
          name: partnerId
          schema:
            description: Partner ID to filter by.
            type: string
          description: Partner ID to filter by.
        - in: query
          name: includeExpandedFields
          schema:
            description: >-
              Whether to include expanded fields on the customer (`link`,
              `partner`, `discount`).
            type: boolean
          description: >-
            Whether to include expanded fields on the customer (`link`,
            `partner`, `discount`).
        - in: query
          name: sortBy
          schema:
            default: createdAt
            description: The field to sort the customers by. The default is `createdAt`.
            type: string
            enum:
              - createdAt
              - saleAmount
          description: The field to sort the customers by. The default is `createdAt`.
        - in: query
          name: sortOrder
          schema:
            default: desc
            description: The sort order. The default is `desc`.
            type: string
            enum:
              - asc
              - desc
          description: The sort order. The default is `desc`.
        - in: query
          name: page
          schema:
            default: 1
            description: The page number for pagination.
            example: 1
            type: number
            minimum: 0
            exclusiveMinimum: true
          description: The page number for pagination.
        - in: query
          name: pageSize
          schema:
            default: 100
            description: The number of items per page.
            example: 50
            type: number
            minimum: 0
            exclusiveMinimum: true
            maximum: 100
          description: The number of items per page.
      responses:
        '200':
          description: The list of customers.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: >-
                        The unique ID of the customer. You may use either the
                        customer's `id` on Dub (obtained via `/customers`
                        endpoint) or their `externalId` (unique ID within your
                        system, prefixed with `ext_`, e.g. `ext_123`).
                    externalId:
                      type: string
                      description: Unique identifier for the customer in the client's app.
                    name:
                      type: string
                      description: Name of the customer.
                    email:
                      description: Email of the customer.
                      nullable: true
                      type: string
                    avatar:
                      description: Avatar URL of the customer.
                      nullable: true
                      type: string
                    country:
                      description: Country of the customer.
                      nullable: true
                      type: string
                    sales:
                      description: Total number of sales for the customer.
                      nullable: true
                      type: number
                    saleAmount:
                      description: Total amount of sales for the customer.
                      nullable: true
                      type: number
                    createdAt:
                      description: The date the customer was created.
                      type: string
                    link:
                      nullable: true
                      type: object
                      properties:
                        id:
                          type: string
                          description: The unique ID of the short link.
                        domain:
                          type: string
                          description: >-
                            The domain of the short link. If not provided, the
                            primary domain for the workspace will be used (or
                            `dub.sh` if the workspace has no domains).
                        key:
                          type: string
                          description: >-
                            The short link slug. If not provided, a random
                            7-character slug will be generated.
                        shortLink:
                          type: string
                          format: uri
                          description: >-
                            The full URL of the short link, including the https
                            protocol (e.g. `https://dub.sh/try`).
                        url:
                          type: string
                          format: uri
                          description: The destination URL of the short link.
                        programId:
                          nullable: true
                          description: >-
                            The ID of the program the short link is associated
                            with.
                          type: string
                      required:
                        - id
                        - domain
                        - key
                        - shortLink
                        - url
                        - programId
                      additionalProperties: false
                    programId:
                      nullable: true
                      type: string
                    partner:
                      nullable: true
                      type: object
                      properties:
                        id:
                          type: string
                          description: The partner's unique ID on Dub.
                        name:
                          type: string
                          maxLength: 190
                          description: The partner's full legal name.
                        email:
                          nullable: true
                          description: >-
                            The partner's email address. Should be a unique
                            value across Dub.
                          type: string
                          maxLength: 190
                        image:
                          nullable: true
                          description: The partner's avatar image.
                          type: string
                      required:
                        - id
                        - name
                        - email
                        - image
                      additionalProperties: false
                    discount:
                      nullable: true
                      type: object
                      properties:
                        id:
                          type: string
                        amount:
                          type: number
                        type:
                          type: string
                          enum:
                            - percentage
                            - flat
                        maxDuration:
                          nullable: true
                          type: number
                        couponId:
                          nullable: true
                          type: string
                        couponTestId:
                          nullable: true
                          type: string
                        description:
                          nullable: true
                          type: string
                        partnersCount:
                          nullable: true
                          type: number
                      required:
                        - id
                        - amount
                        - type
                        - maxDuration
                        - couponId
                        - couponTestId
                      additionalProperties: false
                  required:
                    - id
                    - externalId
                    - name
                    - createdAt
                  additionalProperties: false
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '410':
          $ref: '#/components/responses/410'
        '422':
          $ref: '#/components/responses/422'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      security:
        - token: []
components:
  responses:
    '400':
      description: >-
        The server cannot or will not process the request due to something that
        is perceived to be a client error (e.g., malformed request syntax,
        invalid request message framing, or deceptive request routing).
      content:
        application/json:
          schema:
            x-speakeasy-name-override: BadRequest
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - bad_request
                    description: A short code indicating the error code returned.
                    example: bad_request
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: >-
                      A link to our documentation with more details about this
                      error code
                    example: https://dub.co/docs/api-reference/errors#bad-request
                required:
                  - code
                  - message
            required:
              - error
    '401':
      description: >-
        Although the HTTP standard specifies "unauthorized", semantically this
        response means "unauthenticated". That is, the client must authenticate
        itself to get the requested response.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: Unauthorized
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unauthorized
                    description: A short code indicating the error code returned.
                    example: unauthorized
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: >-
                      A link to our documentation with more details about this
                      error code
                    example: https://dub.co/docs/api-reference/errors#unauthorized
                required:
                  - code
                  - message
            required:
              - error
    '403':
      description: >-
        The client does not have access rights to the content; that is, it is
        unauthorized, so the server is refusing to give the requested resource.
        Unlike 401 Unauthorized, the client's identity is known to the server.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: Forbidden
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - forbidden
                    description: A short code indicating the error code returned.
                    example: forbidden
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: >-
                      A link to our documentation with more details about this
                      error code
                    example: https://dub.co/docs/api-reference/errors#forbidden
                required:
                  - code
                  - message
            required:
              - error
    '404':
      description: The server cannot find the requested resource.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: NotFound
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - not_found
                    description: A short code indicating the error code returned.
                    example: not_found
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: >-
                      A link to our documentation with more details about this
                      error code
                    example: https://dub.co/docs/api-reference/errors#not-found
                required:
                  - code
                  - message
            required:
              - error
    '409':
      description: >-
        This response is sent when a request conflicts with the current state of
        the server.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: Conflict
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - conflict
                    description: A short code indicating the error code returned.
                    example: conflict
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: >-
                      A link to our documentation with more details about this
                      error code
                    example: https://dub.co/docs/api-reference/errors#conflict
                required:
                  - code
                  - message
            required:
              - error
    '410':
      description: >-
        This response is sent when the requested content has been permanently
        deleted from server, with no forwarding address.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: InviteExpired
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - invite_expired
                    description: A short code indicating the error code returned.
                    example: invite_expired
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: >-
                      A link to our documentation with more details about this
                      error code
                    example: https://dub.co/docs/api-reference/errors#invite-expired
                required:
                  - code
                  - message
            required:
              - error
    '422':
      description: >-
        The request was well-formed but was unable to be followed due to
        semantic errors.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: UnprocessableEntity
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - unprocessable_entity
                    description: A short code indicating the error code returned.
                    example: unprocessable_entity
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: >-
                      A link to our documentation with more details about this
                      error code
                    example: >-
                      https://dub.co/docs/api-reference/errors#unprocessable-entity
                required:
                  - code
                  - message
            required:
              - error
    '429':
      description: >-
        The user has sent too many requests in a given amount of time ("rate
        limiting")
      content:
        application/json:
          schema:
            x-speakeasy-name-override: RateLimitExceeded
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - rate_limit_exceeded
                    description: A short code indicating the error code returned.
                    example: rate_limit_exceeded
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: >-
                      A link to our documentation with more details about this
                      error code
                    example: >-
                      https://dub.co/docs/api-reference/errors#rate-limit_exceeded
                required:
                  - code
                  - message
            required:
              - error
    '500':
      description: The server has encountered a situation it does not know how to handle.
      content:
        application/json:
          schema:
            x-speakeasy-name-override: InternalServerError
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                      - internal_server_error
                    description: A short code indicating the error code returned.
                    example: internal_server_error
                  message:
                    x-speakeasy-error-message: true
                    type: string
                    description: A human readable explanation of what went wrong.
                    example: The requested resource was not found.
                  doc_url:
                    type: string
                    description: >-
                      A link to our documentation with more details about this
                      error code
                    example: >-
                      https://dub.co/docs/api-reference/errors#internal-server_error
                required:
                  - code
                  - message
            required:
              - error
  securitySchemes:
    token:
      type: http
      description: Default authentication mechanism
      scheme: bearer
      x-speakeasy-example: DUB_API_KEY

````