> ## Documentation Index > Fetch the complete documentation index at: https://docs.dakota.xyz/llms.txt > Use this file to discover all available pages before exploring further. # List users > Get a list of all users ## OpenAPI ````yaml /openapi.yaml get /users openapi: 3.0.3 info: title: Dakota Platform API version: 1.0.0 description: >- Combined API specification for Dakota Platform services: - Issuance API: Asset minting and burning operations - Onboarding API: Know Your Business/Customer verification - On/Off Ramp API: Managing on-ramp and off-ramp accounts - Recipients API: Managing destinations for KYB'd entities - Transactions API: Viewing transaction history across platform operations ## Authentication and API Headers All API endpoints require the following headers: - `x-idempotency-key`: Required for all POST endpoints to ensure request idempotency - `x-api-key`: Required for authentication across all endpoints Note: On /applications endpoints you need a token for authentication instead of a x-api-key - `x-application-token`: Required for authentication on public /applications endpoints (alternative to `x-api-key` where documented) ## Rate Limits Requests are rate limited per API key. Every response includes the following headers: | Header | Description | | --- | --- | | `X-RateLimit-Limit` | Maximum requests allowed in the current one-minute window. | | `X-RateLimit-Remaining` | Requests remaining in the current window. | | `X-RateLimit-Reset` | Absolute Unix timestamp (seconds since epoch) when the current rate-limit window resets. | When a request is throttled (`429`), responses also include `Retry-After` with seconds to wait before retrying. servers: - url: https://api.platform.dakota.xyz description: Production environment - url: https://api.platform.sandbox.dakota.xyz description: Sandbox — safe for testing with simulated data security: - ApiKeyAuth: [] tags: - name: Agentic Payments x-alpha: true description: >- Alpha — agent-driven payments: provision agents, draft and approve spending mandates, accept reviewed instructions, and manage scheduled payments. **Prerequisites:** Customer onboarded; signer groups attached for recognition. **Related:** Wallets, Signer Groups, Transactions - name: Mandates x-alpha: true description: >- Alpha — spending mandates: signed, signer-bound authorizations governing what may be spent, approved or cancelled by a second recognized signer (§8 — the dual-control rule that every mandate mutation must be signed by a recognized signer OTHER than the bound one). Independent of agents and scheduled payments. **Prerequisites:** Signer groups attached for recognition. **Related:** Signer Groups, Transactions - name: Insights x-alpha: true description: >- Alpha — read-only account insight: a deterministic report over a customer's agentic activity (funding balances, upcoming obligations, failures, mandate headroom and expiry) plus an advisory chat that narrates it. Never moves money, never creates or changes anything. **Prerequisites:** Customer onboarded; insight is computed from the customer's scheduled payments, mandates, and wallets. **Related:** Agentic Payments, Mandates - name: Customers description: >- Manage customer entities representing businesses and organizations onboarded to Dakota. **Prerequisites:** Complete KYB via Onboarding endpoints before initiating money movement. **Related:** Onboarding, Recipients, Transactions, Accounts, Wallets - name: Wallets description: >- Manage wallets, balances, and wallet-to-signer-group relationships for custody and movement controls. **Prerequisites:** Customer must exist. Configure signer groups before policy-enforced workflows. **Related:** Signer Groups, Policies, Transactions, Customers - name: Transactions description: >- Create, cancel, and retrieve transaction records across account and wallet flows. **Prerequisites:** Accounts or destinations must be configured based on flow type. **Related:** Accounts, Recipients, Policies, Events - name: Recipients description: >- Manage recipient entities and destination rails used by customers for payouts and transfers. **Prerequisites:** Customer must be onboarded and active. **Related:** Customers, Transactions, Accounts, Onboarding - name: Accounts description: >- Manage account resources used for onramp, offramp, and swap operations. **Prerequisites:** Customer must be created and network/asset constraints must be known. **Related:** Customers, Transactions, Auto Transactions, Info - name: Auto Transactions description: >- Manage automated transaction configurations and execution history for account automation workflows. **Prerequisites:** Source account must exist and be configured for automation. **Related:** Accounts, Transactions, Events - name: Onboarding description: >- Manage KYB/KYC onboarding lifecycle, application documents, attestations, and verification steps. **Prerequisites:** Customer context and required entity/application metadata. **Related:** Customers, Exceptions, Recipients, Transactions - name: Policies description: >- Define and manage policy objects and rules used for transaction governance and risk controls. **Prerequisites:** Wallet and signer group resources should be configured for enforcement scenarios. **Related:** Wallets, Signer Groups, Transactions - name: Signer Groups description: >- Manage signer groups and signer assignments for multi-party authorization models. **Prerequisites:** Wallets should exist before linking signer groups. **Related:** Wallets, Policies, Transactions - name: Authentication description: >- Manage API authentication credentials and key lifecycle for platform access. **Prerequisites:** Client organization must be provisioned. **Related:** Users, Info - name: Users description: >- Manage client users, roles, and identity metadata for platform access control. **Prerequisites:** Auth credentials and client context must be established. **Related:** Authentication - name: Webhooks description: >- Manage outbound webhook targets and delivery configuration for event notifications. **Prerequisites:** Subscriber endpoint must be reachable and secured. **Related:** Events, Authentication - name: Payouts description: >- Manage where Dakota sends your accrued developer-fee payouts. **Prerequisites:** Auth credentials and client context must be established. **Related:** Events - name: Events description: >- Retrieve event records emitted by platform operations for audit and troubleshooting. **Prerequisites:** Requesting client must have access to referenced resources. **Related:** Webhooks, Transactions, Onboarding - name: Info description: >- Read platform capability metadata, such as supported rails, networks, and assets. **Prerequisites:** Valid authentication headers. **Related:** Accounts, Transactions - name: Sandbox description: >- Trigger sandbox-only simulation endpoints for safe end-to-end integration testing with synthetic data. The sandbox host (`https://api.platform.sandbox.dakota.xyz`) also accepts a family of `X-Sandbox-*` request headers on most write endpoints (`Customers`, `Accounts`, `Transactions`, simulate endpoints) that let integrators drive deterministic failure modes — pick a preset via `X-Sandbox-Scenario`, or compose a custom one with `X-Sandbox-Error-Step`/`X-Sandbox-Error-Status`/`X-Sandbox-Error-Message`. `X-Sandbox-Instant-Completion` collapses async flows to a single synchronous step, and `X-Sandbox-Skip-Auto-Approval` keeps newly created KYB applications in `pending` for manual-review testing. All `X-Sandbox-*` headers are ignored in production. **Prerequisites:** Sandbox environment and test customer data. **Related:** Customers, Accounts, Transactions, Onboarding paths: /users: get: tags: - Users summary: List users description: Get a list of all users operationId: listClientUsers parameters: - $ref: '#/components/parameters/LimitParam' - $ref: '#/components/parameters/StartingAfterParam' - $ref: '#/components/parameters/EndingBeforeParam' - name: search in: query description: Fuzzy search across first/last name, email, and user ID. required: false schema: type: string - name: created_at_from in: query description: >- Filter users created at or after this ISO 8601 datetime (e.g. 2024-01-01T00:00:00Z). required: false schema: type: string format: date-time - name: created_at_to in: query description: >- Filter users created at or before this ISO 8601 datetime (e.g. 2024-12-31T23:59:59Z). required: false schema: type: string format: date-time - name: roles in: query description: >- Filter users by one or more roles. Comma-separated list (e.g. `admin,member`). required: false schema: type: string - name: sort_by in: query description: Field to sort users by. Defaults to `created_at`. required: false schema: type: string enum: - created_at - email - name - role - name: sort_dir in: query description: Sort direction. Defaults to `desc`. required: false schema: type: string enum: - asc - desc responses: '200': description: List of users content: application/json: schema: allOf: - $ref: '#/components/schemas/PaginatedListResponse' - type: object properties: data: type: array items: $ref: '#/components/schemas/ClientUser' example: data: - id: 1NFHrqBHb3cTfLVkFSGmHZqdDPi first_name: John last_name: Doe email: john@example.com role: admin swift_enabled: true created_at: 1234567890 meta: total_count: 100 has_more_after: true has_more_before: false '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://docs.dakota.xyz/api-reference/errors#invalid-request title: Bad Request status: 400 detail: Bad Request instance: https://api.platform.dakota.xyz/users request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6 '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: >- https://docs.dakota.xyz/api-reference/errors#authentication-error title: Unauthorized status: 401 detail: Unauthorized instance: https://api.platform.dakota.xyz/users request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6 '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' example: type: https://docs.dakota.xyz/api-reference/errors#forbidden title: Forbidden status: 403 detail: Forbidden instance: https://api.platform.dakota.xyz/users request_id: req_01hzy6y7v8w9x0y1z2a3b4c5d6 externalDocs: description: Read full guide in docs url: https://docs.dakota.xyz/api-reference/users/list-users components: parameters: LimitParam: name: limit in: query required: false description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. schema: type: integer minimum: 1 maximum: 100 default: 20 StartingAfterParam: name: starting_after in: query required: false description: >- A cursor for use in pagination. `starting_after` is a KSUID for the object you are listing that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with ID `2B5J8KZ9N7M1K3P6Q8R4T7V9`, your subsequent call can include `starting_after=2B5J8KZ9N7M1K3P6Q8R4T7V9` in order to fetch the next page of the list. schema: $ref: '#/components/schemas/KSUID' EndingBeforeParam: name: ending_before in: query required: false description: >- A cursor for use in pagination. `ending_before` is a KSUID for the object you are listing that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with ID `2B5J8KZ9N7M1K3P6Q8R4T7V9`, your subsequent call can include `ending_before=2B5J8KZ9N7M1K3P6Q8R4T7V9` in order to fetch the previous page of the list. schema: $ref: '#/components/schemas/KSUID' schemas: PaginatedListResponse: type: object description: Wrapper for paginated list responses required: - data - meta properties: data: type: array description: List of objects returned by the API items: type: object meta: $ref: '#/components/schemas/Meta' ClientUser: type: object description: >- User object representing a user in the system, including all clients they can access. required: - id - first_name - last_name - email - role - created_at properties: id: $ref: '#/components/schemas/KSUID' first_name: type: string description: Given name of the user. example: John last_name: type: string description: Surname of the user. example: Doe email: type: string description: Email address of the user. example: john@example.com role: $ref: '#/components/schemas/ClientUserRole' swift_enabled: type: boolean description: Whether the client has SWIFT payments enabled. client_id: $ref: '#/components/schemas/KSUID' client_name: type: string description: Display name of the active client for this request. example: Acme Corp created_at: type: integer description: Timestamp of when the user was created. example: 1234567890 ProblemDetails: type: object required: - type - title - status description: | Error response following RFC 9457 Problem Details. Public API error responses use this format. example: type: https://docs.dakota.xyz/api-reference/errors#not-found title: Customer Not Found status: 404 detail: Customer cst_2abc123 was not found in your organization. instance: https://api.platform.dakota.xyz/customers/cst_2abc123 request_id: req_7f3a8b2c properties: type: type: string format: uri description: | URI reference identifying the problem type. Resolves to human-readable documentation. example: https://docs.dakota.xyz/api-reference/errors#not-found title: type: string description: >- Short, human-readable summary of the problem type. Stable across occurrences. example: Customer Not Found status: type: integer description: HTTP status code for this occurrence. example: 404 detail: type: string description: Human-readable explanation specific to this occurrence. example: Customer cst_2abc123 was not found in your organization. instance: type: string format: uri description: The request path that triggered this error. example: https://api.platform.dakota.xyz/customers/cst_2abc123 request_id: type: string description: Unique request identifier. Include when contacting support. example: req_7f3a8b2c errors: type: array description: Field-level validation errors (present for validation failures). items: $ref: '#/components/schemas/ValidationError' KSUID: type: string title: KSUID description: >- KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform. pattern: ^[0-9A-Za-z]{27}$ minLength: 27 maxLength: 27 example: 1NFHrqBHb3cTfLVkFSGmHZqdDPi Meta: type: object description: Meta information about the response required: - total_count - has_more_after - has_more_before properties: total_count: type: integer description: Total number of items available example: 100 has_more_after: type: boolean description: Indicates whether there are more items that follow this set. example: true has_more_before: type: boolean description: Indicates whether there are more items that precede this set. example: false ClientUserRole: type: string description: >- Role that can be assigned to a client user. Available roles: `admin` (full access except issuances) and `viewer` (read-only access). enum: - admin - viewer example: admin ValidationError: type: object required: - field - message properties: field: type: string description: Field path using dot notation for nested fields. example: bank_account.routing_number message: type: string description: Human-readable description of the field error. example: Routing number must be exactly 9 digits code: type: string description: Machine-readable error code for this field. example: invalid_format securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key ````