> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluid.app/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract. > Authenticate with the header Authorization: Bearer ; public storefront read endpoints require no auth. > Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null. > Never use /api/company/v1 or /api/v1 paths, page/per_page params, or offset pagination — they are legacy. > The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/auth-v0.yaml covers the unversioned auth surface (/api/... paths — authentication, MFA, social auth, and token exchange); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. # List users > Lists users for the authenticated company. Page paginated. ## OpenAPI ````yaml /api-reference/checkout-v2026-04.yaml get /api/checkout/v2026-04/users openapi: 3.1.0 info: title: Fluid Checkout API description: >- **Fluid Checkout API — for building a checkout directly against REST.** Use this surface if you are integrating server-to-server or building your own checkout UI. It covers the full order lifecycle (cart → address → shipping → discount → complete → order) plus the logged-in customer's account: saved addresses, saved payment methods, order history, loyalty points, and subscription management (pause, resume, skip, cancel, retry). **The cart token in the URL scopes cart access** — creating a cart, adding items, applying a discount, and completing a cart need no bearer token. Among the cart operations, a Bearer token is required only for `carts/{cart_token}/sync`, `carts/{cart_token}/volume_rep`, and `carts/{cart_token}/discount/manual`. Off the cart, a token is required for everything under `customers/me` and `subscriptions`, and for the store and directory lookups (`store/config`, `store/languages`, `reps`, `users`) and `subscription_bundles`. `store/countries` accepts a token but does not require one — it returns the same list either way. **If you are using the `@fluid-app` FairShare SDK in a theme or storefront, you are not calling this surface** — the SDK calls the Fluid Public SDK API (`public-v2025-06`). Do not mix the two against one cart: they share the same cart records and services, but their request shapes differ. See [Choosing a cart surface](https://docs.fluid.app/api/choosing-a-cart-surface) for the operation map and boundary. version: v2026-04 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: carts description: >- Create, read, and mutate checkout carts (email, address, country, language, shipping, recalculation, completion). - name: cart-auth description: >- Cart-scoped customer authentication — magic-link challenge, verification, identity, and logout. - name: cart-discount description: >- Apply, list, and remove cart discount codes, including admin manual discounts. - name: cart-items description: Add, update, and remove line items on a cart. - name: cart-points description: Apply and remove loyalty points on a cart. - name: customers description: The authenticated customer's profile and company memberships. - name: customer-addresses description: The authenticated customer's saved shipping/billing addresses. - name: customer-orders description: The authenticated customer's order history. - name: customer-payment-methods description: The authenticated customer's saved payment methods and tokenization. - name: customer-points description: The authenticated customer's loyalty point balances. - name: directory description: Company rep and user directory lookups. - name: enrollments description: >- Public enrollment forms — retrieve a form and submit, update, or upload field answers. - name: orders description: Public order lookup by token. - name: products description: Public product queries for the storefront checkout. - name: store description: >- Store-level checkout configuration — countries, languages, address fields, agreements, drop zones, and Apple Pay domain verification. - name: subscriptions description: >- Manage subscriptions — pause, resume, skip, cancel, reactivate, retry, and failed-cycle waivers. - name: subscription-bundles description: List and create subscription bundles. paths: /api/checkout/v2026-04/users: get: tags: - directory summary: List users description: Lists users for the authenticated company. Page paginated. operationId: checkout_v2026_04_list_users parameters: - name: page in: query required: false description: Page number schema: type: integer minimum: 1 default: 1 - name: per_page in: query required: false description: Number of records per page schema: type: integer minimum: 1 maximum: 100 default: 50 - name: search_query in: query required: false description: Search query schema: type: string - name: sorted_by in: query required: false description: Sort expression schema: type: string - name: role in: query required: false description: User role filter schema: type: string - name: by_metadata in: query required: false description: JSON-encoded metadata filters schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CheckoutUserCompanyListResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '422': description: Unprocessable Entity content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearer_auth: [] components: schemas: CheckoutUserCompanyListResponse: type: object properties: meta: $ref: '#/components/schemas/PaginatedMeta' user_companies: type: array items: type: object properties: active: type: boolean affiliate: type: object properties: credit: type: - string - 'null' email: type: - string - 'null' external_id: type: - string - 'null' id: type: - integer - 'null' username: type: - string - 'null' additionalProperties: false company_id: type: integer created_at: type: string format: date-time customer_id: type: - integer - 'null' email: type: string external_id: type: - string - 'null' first_name: type: string full_name: type: string id: type: integer image_url: type: - string - 'null' last_name: type: string legacy_number: type: 'null' metadata: type: object additionalProperties: false mysite_url: type: string rank: type: - string - 'null' rank_id: type: - integer - 'null' roles: type: array items: $ref: '#/components/schemas/JsonValue' share_guid: type: string user: type: object properties: addresses: type: array items: type: - object - 'null' properties: address1: type: string address2: type: 'null' address3: type: 'null' city: type: string country_code: type: string country_num_code: type: integer default: type: boolean id: type: integer name: type: string phone: type: - string - 'null' postal_code: type: string state: type: string subdivision_code: type: 'null' required: - address1 - address2 - address3 - city - country_code - country_num_code - default - id - name - phone - postal_code - state - subdivision_code additionalProperties: false avatar: type: 'null' bio: type: - string - 'null' country: type: - object - 'null' properties: id: type: integer iso: type: string name: type: string required: - id - iso - name additionalProperties: false dnd: type: string dob: type: 'null' email: type: string facebook: type: 'null' first_name: type: string gender: type: 'null' google_id: type: 'null' id: type: integer instagram: type: 'null' language: type: - object - 'null' properties: id: type: integer iso: type: string name: type: string required: - id - iso - name additionalProperties: false last_name: type: string linkedin: type: 'null' phone: type: - string - 'null' time_zone: type: - string - 'null' twitter: type: 'null' user_type: type: string wechat: type: 'null' whatsapp: type: 'null' youtube: type: 'null' zip_code: type: 'null' required: - addresses - avatar - bio - country - dnd - dob - email - facebook - first_name - gender - google_id - id - instagram - language - last_name - linkedin - phone - time_zone - twitter - user_type - wechat - whatsapp - youtube - zip_code additionalProperties: false username: type: string required: - active - affiliate - company_id - created_at - customer_id - email - external_id - first_name - full_name - id - image_url - last_name - legacy_number - metadata - mysite_url - rank - rank_id - roles - share_guid - user - username additionalProperties: false required: - meta - user_companies additionalProperties: false UnauthorizedResponse: type: object properties: message: type: string required: - message ErrorResponse: type: object additionalProperties: false required: - error_message - errors - meta properties: error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/CheckoutMeta' PaginatedMeta: type: object properties: pagination: $ref: '#/components/schemas/Pagination' request_id: type: string timestamp: type: string format: date-time required: - pagination - request_id - timestamp additionalProperties: false JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' CheckoutMeta: type: object additionalProperties: false required: - request_id - timestamp properties: request_id: type: - string - 'null' timestamp: type: string format: date-time Pagination: type: object properties: current_page: type: integer per_page: type: integer total_count: type: integer total_pages: type: integer required: - current_page - per_page - total_count - total_pages additionalProperties: false ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````