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

# List customers

> Returns a paginated list of customers in your organization.
Supports optional case-insensitive substring filters on `name`
and `email`. When both filters are provided, only customers
matching both are returned. Results are scoped to the
authenticated organization.




## OpenAPI

````yaml /nickel-api-docs.yaml get /customers
openapi: 3.0.3
info:
  title: Nickel API
  description: >-
    This is the specification for the Nickel Rest API. The API lets you
    programmatically interact with the Nickel server. It uses resource oriented
    URLs, accepts and returns JSON encoded payloads and uses standard HTTP
    response codes. It is not a direct API to move money, but instead allows you
    to interact with Nickel as you would on a web interface.
  termsOfService: https://www.nickel.com/terms-of-service
  contact:
    email: support@nickel.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
  - url: https://rest.staging.nickel.com
    description: Sandbox / Staging
  - url: https://rest.nickel.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Payment
    description: Payments from your customers to you
  - name: Disbursement
    description: Payouts made from Nickel to you
  - name: Payment Link
    description: A request for payment against an invoice
  - name: Customer
    description: A customer record to request payments against
  - name: Charge Authorization
    description: >-
      An authorization for your customer to allow you to charge their payment
      method directly
  - name: Webhook
    description: Create a webhook for nickel to send updates to
  - name: File
    description: A file you can use to attach to invoices or debit authorizations
  - name: Vendor
    description: Manage vendors for accounts payable
  - name: Bill
    description: Bills from vendors and bill payments
  - name: Bill Payment Method
    description: >-
      A merchant's payment methods used to pay bills (bank accounts and cards on
      file)
  - name: Vendor Payout Method
    description: Vendor bank account and delivery method management
externalDocs:
  description: Find out more about Nickel
  url: https://nickel.com
paths:
  /customers:
    get:
      tags:
        - Customer
      summary: List customers
      description: |
        Returns a paginated list of customers in your organization.
        Supports optional case-insensitive substring filters on `name`
        and `email`. When both filters are provided, only customers
        matching both are returned. Results are scoped to the
        authenticated organization.
      operationId: listCustomers
      parameters:
        - name: page
          in: query
          description: 1-indexed page number for pagination.
          required: false
          schema:
            type: integer
            minimum: 1
            example: 1
        - name: pageSize
          in: query
          description: Number of results per page.
          required: false
          schema:
            type: integer
            minimum: 1
            example: 25
        - name: name
          in: query
          description: Case-insensitive substring filter applied to the customer's name.
          required: false
          schema:
            type: string
            example: claudio
        - name: email
          in: query
          description: >-
            Case-insensitive substring filter applied to any of the customer's
            email addresses.
          required: false
          schema:
            type: string
            example: example.com
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerListResponse'
        '400':
          description: Invalid pagination parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CustomerListResponse:
      type: object
      properties:
        customers:
          type: array
          description: The page of customer records that match the supplied filters.
          items:
            $ref: '#/components/schemas/Customer'
        totalResults:
          type: integer
          description: Total number of customers matching the filters across all pages.
    Error:
      required:
        - error
      type: object
      properties:
        error:
          type: string
          description: >-
            A human-readable error message describing what went wrong. Note that
            some 500 responses may return a plain text string instead of this
            JSON object.
    Customer:
      type: object
      properties:
        id:
          type: string
          example: clkqzo2y1000cx9tfohoiodq1
        name:
          type: string
          example: Claudio Wilson
        emails:
          type: array
          items:
            type: string
        achEnabled:
          type: boolean
          nullable: true
          description: >-
            Per-customer override for whether ACH/bank payments are allowed.
            null means no customer-level override (inherits the organization
            default). A payment link can further override this at checkout, so a
            customer-level true may still be disabled for a specific link.
          example: false
        feePassthroughPercent:
          type: integer
          nullable: true
          description: >-
            Effective percent (0-100) of the card processing fee passed through
            to this customer: the per-customer override if one is set, otherwise
            the organization default. A per-payment-link feePassthroughPercent
            takes precedence over this value.
          example: 100
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````