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

# List customers

> Permissions required: **Read Customers**

List customers for the organization. Returns summary entries only; use
`GET /customers/{customerId}` to fetch full details.



## OpenAPI

````yaml /knowledge-base/openapi/v4.yaml get /customers
openapi: 3.1.0
info:
  title: Anchorage Digital Account APIs (v4)
  version: 4.0.0-beta
  description: >-
    Reference for the Anchorage Digital v4 API, the surface behind Crypto as a
    Service: account management (accounts and the account tree, beneficiaries,
    freeze/unfreeze/close), balances and transactions, trusted destinations,
    orders and allocations, withdrawals, deposit instructions, deposit
    attributions, the policy engine (policies, approval keys), and supported
    asset types. Approval groups, endorsements, compliance profiles, customers
    (onboarding), fee configuration updates, interest enrollment, funding
    allocations, and destination removal are under construction and return
    mocked data only.


    Status: BETA. The v4 API is available in the sandbox only
    (https://api.anchorage-staging.com/v4) and is not available in production
    yet. The contract may change until general availability. Which endpoints are
    live, in final testing, or under construction:
    https://docs.anchorage.com/platform/developers/caas/caas-overview


    Authentication: every request carries an `Api-Access-Key` header. Every
    POST, PATCH, and DELETE additionally requires an `Idempotency-Key`, and is
    signed with `Api-Signature` (hex-encoded Ed25519 over
    `timestamp_epoch_seconds + uppercase(http_method) + request_path +
    request_body`) plus `Api-Timestamp` (unix epoch seconds).


    Pagination: list endpoints accept `after` (cursor) and `limit` (page size, 1
    to 1000, default 100) and return a `page.endCursor` to continue from. Errors
    use a common envelope with a human-readable `message`; batch endpoints
    return a result per item instead.


    Guides: https://docs.anchorage.com/platform/developers/caas/caas-overview
servers:
  - url: https://api.anchorage-staging.com/v4
security:
  - Api-Access-Key: []
tags:
  - name: Accounts
  - name: Compliance Profiles
  - name: Balances
  - name: Transactions
  - name: Trusted Destinations
  - name: Orders & Allocations
  - name: Withdrawals
  - name: Deposit Instructions
  - name: Deposit Attributions
  - name: Policies
  - name: Approval Groups
  - name: Endorsements
  - name: Customers
  - name: Asset Types
paths:
  /customers:
    get:
      tags:
        - Customers
      summary: List customers
      description: |-
        Permissions required: **Read Customers**

        List customers for the organization. Returns summary entries only; use
        `GET /customers/{customerId}` to fetch full details.
      operationId: listCustomers
      parameters:
        - in: query
          description: >-
            When paginating this is used to provide the starting point for the
            page to fetch (retrieved from the previous response body)
          name: after
          schema:
            type: string
            minLength: 1
        - in: query
          name: limit
          schema:
            maximum: 1000
            default: 100
            type: integer
            format: int64
            minimum: 1
          description: Maximum number of results to return per query
      responses:
        '200':
          description: List of customers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCustomersResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
components:
  schemas:
    ListCustomersResponse:
      title: List Customers Response
      type: object
      required:
        - data
        - page
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomerSummary'
        page:
          $ref: '#/components/schemas/Page'
    ErrorDetails:
      title: ErrorDetails
      type: object
      properties:
        message:
          description: A human-readable message providing more details about the error.
          example: Missing required field 'amount'.
          type: string
      required:
        - message
    CustomerSummary:
      title: Customer Summary
      type: object
      description: Compact view of a customer used for list responses
      required:
        - customerId
        - customerType
        - state
      properties:
        customerId:
          description: Unique identifier for the customer
          type: string
          format: uuid
          example: 3486b413-93d3-4447-afce-2b9c9dc34a32
        externalId:
          type: string
          description: External identifier provided by the client
        customerType:
          $ref: '#/components/schemas/CustomerType'
        state:
          $ref: '#/components/schemas/CustomerState'
    Page:
      title: Page
      description: Pagination info
      type: object
      properties:
        endCursor:
          description: Submit this parameter in the "after" field to fetch the next page.
          type: string
          nullable: true
    CustomerType:
      title: Customer Type
      type: string
      description: The type of customer
      enum:
        - INDIVIDUAL
        - BUSINESS
    CustomerState:
      title: Customer State
      type: string
      description: The state of a customer onboarding application
      enum:
        - DRAFT
        - IN_PROGRESS
        - IN_REVIEW
        - APPROVED
        - REJECTED
  securitySchemes:
    Api-Access-Key:
      type: apiKey
      name: Api-Access-Key
      in: header
      description: An API key associated with a security role

````

## Related topics

- [List customer documents](https://docs.anchorage.com/knowledge-base/api-reference/v4/customers/list-customer-documents.md)
- [List customer onboarding applications](https://docs.anchorage.com/knowledge-base/api-reference/v2-platforms/onboarding/list-customer-onboarding-applications.md)
- [List subaccounts](https://docs.anchorage.com/knowledge-base/api-reference/v2/subaccounts/list-subaccounts.md)
- [List compliance profiles](https://docs.anchorage.com/knowledge-base/api-reference/v4/compliance-profiles/list-compliance-profiles.md)
