> ## 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. > When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > 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); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. # List customers > Get all customers with optional filters ## OpenAPI ````yaml /api-reference/company-v0.yaml get /api/customers openapi: 3.1.0 info: title: Fluid Company API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app - url: https://{company}.fluid.app description: Production server with company subdomain variables: company: default: myco description: Company subdomain security: [] paths: /api/customers: get: tags: - customers summary: List customers description: Get all customers with optional filters operationId: commerce_v0_list_customers parameters: - name: search_query in: query required: false description: >- Filter customers with search query that matches with their email, first name, last name or external_id schema: type: string - name: sorted_by in: query required: false example: id_asc description: > Sort the records by one of the supported attributes: - id - email - created_at - updated_at - country - full_name - active_subscriptions_count - inactive_subscriptions_count - orders_count - last_ordered_at The sort attribute should be followed by one of the order directives: '_asc', '_desc' schema: type: string - name: has_subscription in: query schema: type: boolean default: false required: false description: Filter customers who have subscription - name: has_recent_orders in: query schema: type: boolean default: false required: false description: Filter customers who have recent orders made within last 30 days - name: has_failed_orders in: query schema: type: boolean default: false required: false description: Filter customers who have failed orders - name: purchased_more_than_once in: query schema: type: boolean default: false required: false description: Filter customers who have purchased more than once - name: us_customers in: query schema: type: boolean default: false required: false description: Filter customers from US - name: non_us_customers in: query schema: type: boolean default: false required: false description: Filter customers outside from US - name: abandoned_in_the_last_30_days in: query schema: type: boolean default: false required: false description: Filter customers who have abandoned cart within last 30 days - name: reps in: query schema: type: boolean default: false required: false description: Filter customers who are also Reps - name: order_status in: query required: false description: Filter customers by their order status schema: type: string enum: - fulfilled - unfulfilled - name: ordered_since in: query required: false description: >- Filter customers who have ordered since the specified date. Can be used for e.g. last 30 days, 90 days, etc. example: '2024-10-27' schema: type: string - name: location in: query required: false description: >- Filter customers based upon their default address country iso. `US`, `CA`, `UK`, etc. example: CA schema: type: string - name: subscription_status in: query required: false description: >- Filter customers by their subscription orders status. `active` or `inactive` schema: type: string enum: - active - inactive - name: created_between in: query required: false description: >- Filter customers by creation date range. Format: MM-DD-YYYY-MM-DD-YYYY. Examples: '01-01-2024-12-31-2024' (between dates), '01-01-2024-' (after date), '-12-31-2024' (before date). Note: URL-encode the entire parameter value. example: 01-01-2024-12-31-2024 schema: type: string - name: with_total_orders_between in: query required: false description: >- Filter customers by total number of orders range. Format: min-max. Example: '2-5', '2-', '-5' example: 2-5 schema: type: string - name: with_total_spent_between in: query required: false description: >- Filter customers by total amount spent range. Format: min-max. Example: '200-500', '200-', '-500' example: 200-500 schema: type: string - name: active_subscription_amount_between in: query required: false description: >- Filter customers by total amount of active subscription orders (e.g. '100-500' or '100-' or '-500') example: 100-500 schema: type: string - name: inactive_subscription_amount_between in: query required: false description: >- Filter customers by total amount of inactive subscription orders (e.g. '100-500' or '100-' or '-500') example: 100-500 schema: type: string - name: for_rep in: query required: false description: Filter customers by their rep id (user_company_id) schema: type: integer - name: page in: query schema: type: integer default: 1 required: false description: Page number for pagination - name: per_page in: query schema: type: integer default: 10 required: false description: Number of records per page - name: by_metadata in: query schema: type: string default: '{}' format: json required: false description: Search JSON meta data responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/ListCustomersResponse200ApplicationJsonSchema '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' security: - bearer_auth: [] components: schemas: ListCustomersResponse200ApplicationJsonSchema: type: - object - 'null' properties: customers: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' account_id: type: - string - number - integer - 'null' first_name: type: - string - number - integer - 'null' last_name: type: - string - number - integer - 'null' full_name: type: - string - number - integer - 'null' email: type: - string - number - integer - 'null' verified_email: type: - boolean - 'null' phone: type: - string - number - integer - 'null' orders_count: type: - integer - string - number - 'null' total_spent: anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' display_total_spent: type: - string - number - integer - 'null' last_order_id: type: - integer - string - number - 'null' notes: type: - string - number - integer - 'null' user_company_id: type: - integer - string - number - 'null' created_at: type: - string - number - integer - 'null' active: type: - boolean - 'null' is_rep: type: - boolean - 'null' is_discarded: type: - boolean - 'null' external_id: type: - string - number - integer - 'null' email_marketing: type: - boolean - 'null' sms_marketing: type: - boolean - 'null' role: type: - string - number - integer - 'null' metadata: type: - object - 'null' description: A JSON object that can store any custom data structure. additionalProperties: $ref: '#/components/schemas/JsonValue' default_address: $ref: '#/components/schemas/CompanyCustomerAddress' addresses: type: - array - 'null' items: $ref: '#/components/schemas/CompanyCustomerAddress' payment_methods: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' company_id: type: - integer - string - number - 'null' created_at: type: - string - number - integer - 'null' logo_url: type: - string - number - integer - 'null' payload: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' source: type: - string - number - integer - 'null' payment_title: type: - string - number - integer - 'null' updated_at: type: - string - number - integer - 'null' user_id: type: - integer - string - number - 'null' customer_notes: type: - array - 'null' items: type: - object - 'null' properties: id: type: - integer - string - number - 'null' customer_id: type: - integer - string - number - 'null' user_company_id: type: - integer - string - number - 'null' note: type: - string - number - integer - 'null' resource_type: type: - string - number - integer - 'null' resource_id: type: - integer - string - number - 'null' created_at: type: - string - number - integer - 'null' active_subscriptions_count: type: - integer - string - number - 'null' inactive_subscriptions_count: type: - integer - string - number - 'null' jwt: type: - string - number - integer - 'null' metafields: type: - array - 'null' items: $ref: '#/components/schemas/CompanyMetafield' meta: $ref: '#/components/schemas/CompanyResponseMeta' StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' 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' CompanyCustomerAddress: type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' address1: type: - string - number - integer - 'null' address2: type: - string - number - integer - 'null' address3: type: - string - number - integer - 'null' city: type: - string - number - integer - 'null' state: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' country_code: type: - string - number - integer - 'null' description: >- country_id takes precedence if both country_id and country_code provided. subdivision_code: type: - string - number - integer - 'null' default: type: - boolean - 'null' CompanyMetafield: title: LegacyMetafield type: - object - 'null' properties: id: type: - integer - string - number - 'null' namespace: description: >- A container for related metafields. Commonly used to group metafields by app or functionality. type: - string - number - integer - 'null' maxLength: 20 pattern: ^[a-zA-Z0-9_]+$ key: description: >- The unique identifier for the metafield within its namespace. Must be unique per namespace and owner. type: - string - number - integer - 'null' maxLength: 30 pattern: ^[a-zA-Z0-9_]+$ value: description: The actual data stored in the metafield. Type depends on value_type. anyOf: - type: - string - number - integer - 'null' - type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' value_type: description: >- The data type that defines how the value should be interpreted and validated. type: - string - number - integer - 'null' description: description: >- Optional human-readable description explaining the purpose of this metafield. type: - string - number - integer - 'null' owner_type: description: >- The type of resource that this metafield belongs to (polymorphic association). type: - string - number - integer - 'null' owner_id: description: The ID of the specific resource that this metafield belongs to. type: - integer - string - number - 'null' created_at: description: Timestamp when the metafield was created. type: - string - number - integer - 'null' format: date-time updated_at: description: Timestamp when the metafield was last updated. type: - string - number - integer - 'null' format: date-time metafield_definition: $ref: '#/components/schemas/CompanyMetafieldDefinition' CompanyResponseMeta: type: - object - 'null' properties: total_count: type: - integer - string - number - 'null' total_pages: type: - integer - string - number - 'null' current_page: type: - integer - string - number - 'null' request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - 'null' StandardErrorResponse: description: >- Common legacy error response envelope. Older endpoints may return one or more of these fields depending on the controller path. type: object properties: message: type: string error: $ref: '#/components/schemas/ErrorMessage' error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' additionalProperties: $ref: '#/components/schemas/JsonValue' CompanyMetafieldDefinition: title: MetafieldDefinition type: - object - 'null' properties: id: type: - integer - string - number - 'null' company_id: description: The ID of the company that owns this metafield definition. type: - integer - string - number - 'null' namespace: description: >- A container for related metafield definitions. Used to group definitions by app or functionality. Must be unique within company and owner_resource. type: - string - number - integer - 'null' maxLength: 20 pattern: ^[a-zA-Z0-9_]+$ key: description: >- The unique identifier for the metafield definition within its namespace and owner_resource. Combined with namespace and owner_resource, this must be unique per company. type: - string - number - integer - 'null' maxLength: 30 pattern: ^[a-zA-Z0-9_]+$ name: description: >- Human-readable display name for the metafield definition, shown in admin interfaces and forms. type: - string - number - integer - 'null' maxLength: 100 description: description: >- Detailed explanation of what this metafield definition represents, how it should be used, and any special instructions for content creators. type: - string - number - integer - 'null' value_type: description: >- The data type that defines how metafield values should be validated, stored, and displayed. Determines which validation rules are available. type: - string - number - integer - 'null' validation_rules: description: >- JSON object containing validation constraints that will be applied to metafield values. Available rules depend on the value_type. type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' owner_resource: description: >- The type of resource (model class name) that metafields using this definition can be attached to. Must match the polymorphic owner_type. type: - string - number - integer - 'null' pinned: description: >- Whether this definition should be prominently displayed or prioritized in admin interfaces and forms. type: - boolean - 'null' default: false position: default: 0 description: >- Sort order for displaying this definition relative to others in the same category and owner_resource. Lower numbers appear first. type: - integer - string - number - 'null' locked: description: >- Whether this metafield definition is locked, preventing direct updates or deletions of metafields using this definition. type: - boolean - 'null' default: false created_at: description: Timestamp when the metafield definition was created. type: - string - number - integer - 'null' format: date-time updated_at: description: Timestamp when the metafield definition was last updated. type: - string - number - integer - 'null' format: date-time list_type: description: >- Whether this definition is for list-type metafields that store arrays of values. type: - boolean - 'null' reference_type: description: >- Whether this definition is for reference-type metafields that store references to other resources. type: - boolean - 'null' supported_validations: description: >- Array of validation rule names that are supported for this value_type. type: - array - 'null' items: $ref: '#/components/schemas/JsonValue' validation_description: description: >- Human-readable description of what the value_type represents and its constraints. type: - string - number - integer - 'null' category_ids: description: >- Array of category IDs that this metafield definition is associated with for organizational purposes. items: type: - integer - string - number - 'null' type: - array - 'null' ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' 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' Meta: type: - object - 'null' properties: request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - 'null' format: date-time 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 ````