> ## Documentation Index > Fetch the complete documentation index at: https://docs.iron.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Get all Customers > Get all customers for a particular partner. The partner ID does not need to be provided as it is provided by the API Key. An optional `search_term` can be provided to filter by name, id, or email. ## OpenAPI ````yaml /spec.yaml get /customers openapi: 3.1.0 info: description: The Stablecoin Payment Network title: Iron API - Sandbox version: 1.0-16030 servers: - url: https://api.sandbox.iron.xyz/api security: [] tags: - description: >- Wallet and bank account registration Every wallet address that interacts with Iron must be registered (linked) to a customer **before** it can be used in any flow — onramp, offramp, or swap. This is a regulatory requirement under the **Travel Rule**, which obliges Virtual Asset Service Providers to exchange originator and beneficiary information for crypto transfers. Iron supports two wallet types: - **Self-hosted wallets** — the customer controls the private key. Registration requires a signed proof-of-ownership message. - **Hosted wallets** — the wallet is custodied by another VASP (e.g. Coinbase, Kraken). Registration requires the VASP's DID so Iron can exchange travel-rule data with the custodian. Similarly, fiat bank accounts must be registered before they can receive offramp payouts. name: Addresses - description: Operations on Autoramp name: Autoramp - description: Operations on Chronicle collateral name: ChronicleCollateral - description: Operations on Currencies name: Currencies - description: Operations on Customers name: Customer - description: Operations on Exchange Rate name: ExchangeRate - description: Operations on Fee Profiles name: FeeProfiles - description: Operations for Sandbox Testing name: Sandbox - description: Operations on SSE name: Sse - description: Operations on Terms and Conditions name: TermsAndConditions - description: Operations on Webhooks name: Webhooks paths: /customers: get: tags: - Customer summary: Get all Customers description: > Get all customers for a particular partner. The partner ID does not need to be provided as it is provided by the API Key. An optional `search_term` can be provided to filter by name, id, or email. operationId: getAllCustomers parameters: - deprecated: false description: >- Optional sub-partner UUID, if provided, the customers will be filtered for the sub-partner explode: true in: header name: X-SUB-PARTNER-ID required: false schema: type: string - deprecated: false description: 'Paging: the cursor field from previous page' explode: false in: query name: cursor required: false schema: default: null format: uuid type: string - deprecated: false description: 'Paging: the cursor field for backward pagination' explode: false in: query name: prev_cursor required: false schema: default: null format: uuid type: string - deprecated: false description: 'Paging: the requested page size (max 100)' explode: false in: query name: page_size required: false schema: default: 10 format: uint32 maximum: 100 type: integer - deprecated: false description: A search term to filter the customers explode: false in: query name: search_term required: false schema: default: null maxLength: 256 type: string - deprecated: false description: Filter by customer status (comma-separated or repeated values) explode: true in: query name: status required: false schema: default: null items: $ref: '#/components/schemas/CustomerStatus' type: array - deprecated: false description: Filter by the customer's most-recent identification status explode: true in: query name: identification_status required: false schema: default: null items: $ref: '#/components/schemas/IdentificationStatus' type: array - deprecated: false description: Filter by customer type (Person or Business) explode: true in: query name: customer_type required: false schema: default: null items: $ref: '#/components/schemas/CustomerType' type: array - deprecated: false description: >- Sort order: "asc" for oldest first, "desc" for newest first (default) explode: false in: query name: sort_order required: false schema: allOf: - $ref: '#/components/schemas/SortOrder' - default: null default: null responses: '200': content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/PagedList_Customer' description: GET ALL Customer Succeeded '401': content: application/json; charset=utf-8: schema: type: string description: GET ALL Customer Failed (Unauthorized) '500': content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/ApiError' description: GET ALL Customer Failed (Internal Error) security: - ApiKeyAuth: [] components: schemas: CustomerStatus: description: | The status of the Customer enum: - UserRequired - SigningsRequired - IdentificationRequired - Active - Suspended type: string IdentificationStatus: description: | The Process status of the identification The various state transitions an identification can go through. enum: - Pending - Processed - PendingReview - Approved - Declined - Expired type: string CustomerType: description: | CustomerType Customers can either be a commercial business or a natural person enum: - Business - Person type: string SortOrder: enum: - asc - desc type: string PagedList_Customer: description: | PagedList A list of items with cursors used to fetch the next or previous page properties: cursor: description: The cursor used to fetch the next page format: uuid type: string items: description: The list of items items: $ref: '#/components/schemas/Customer' type: array prev_cursor: default: null description: The cursor used to fetch the previous page format: uuid type: string required: - items title: PagedList_Customer type: object ApiError: description: |- Standard error response returned to API clients for server errors. Includes a trace_id that clients can reference when reporting issues. properties: message: description: Human-readable error message type: string trace_id: description: Trace ID that can be used to look up request details in logs type: string required: - message - trace_id title: ApiError type: object Customer: description: | Customer The customer object in Iron properties: active_email: description: >- Active email for receiving transaction emails (if different from primary email) type: string created_at: description: Created at timestamp of Customer format: date-time type: string customer_type: $ref: '#/components/schemas/CustomerType' email: description: Email of Customer, collected during identification process type: string external_id: description: External ID for the customer, provided by the partner type: string id: description: Unique ID of Customer format: uuid type: string identification_ids: description: Identifications associated with Customer items: format: uuid type: string type: array identification_status: $ref: '#/components/schemas/IdentificationStatus' name: description: Name of Customer type: string partner_id: description: Partner ID of the customer format: uuid type: string signing_ids: description: Signings associated with Customer items: format: uuid type: string type: array spending_limit_euro: description: >- Spending limit of the customer in EURO (cents), null indicates no limit type: string status: $ref: '#/components/schemas/CustomerStatus' updated_at: description: Updated at timestamp of Customer format: date-time type: string required: - id - customer_type - identification_ids - signing_ids - created_at - updated_at - status - name - email - partner_id title: Customer type: object securitySchemes: ApiKeyAuth: description: API Key in: header name: X-API-Key type: apiKey ````