> ## 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. > To sign a new merchant up for Fluid programmatically, call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch. > 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. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/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. > Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile. > 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/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. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country). > api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. > Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other. > For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces. > Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings. > Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties. > Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables. > A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation. > The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations. > Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check. > Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times. # List the member's contacts > The member's contacts in the lite shape: contacts the membership owns (its `member_id`), in this company or with no company recorded, and contacts held by the membership's user (its `user_id`) in this company, regardless of its `member_id`. Either claim is enough, so a contact reassigned to another member of the company stays in the list of the user who still holds it. A contact moved to another company leaves the member's contacts altogether. Last activity and unread state come from maintained counters. The ETag covers the page; the list is not cached (`max-age=0`). ## OpenAPI ````yaml /api-reference/member-people-v2026-10.yaml get /api/member/v2026-10/contacts openapi: 3.1.0 info: title: Fluid Member API v2026-10 — People description: > The signed-in member's own identity, and the memberships their user holds across companies. Every operation acts as the member the bearer credential speaks for: the member and their company come from the credential alone, never from a path, query or body parameter. A member credential is a member session JWT, a portal JWT whose user company login is linked to a membership in that company, or a member token. Company, partner, public and droplet tokens are refused with 401, as are an admin's token, an admin's or root admin's portal JWT, any credential for a member who is also an admin of that company (their own member session JWT and member token included), a portal JWT with no membership linked to it, and a credential for a member who is removed, inactive or locked, whose user is deleted, or whose company is inactive. A member session JWT is also carried in order and subscription email links, so the contact operations refuse it with 403; a portal JWT or a member token reads contacts. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary version: 2026-10 servers: - url: https://api.fluid.app description: Production API server - url: https://api.fluid.test description: Local development server security: - MemberBearer: [] tags: - name: me description: The signed-in member's own identity - name: profile description: The signed-in member's shared public profile - name: socials x-fluid-section: People description: The signed-in member's shared social accounts - name: companies description: The memberships the signed-in member's user holds, for a company switcher - name: points description: The signed-in member's loyalty points balance and ledger x-fluid-section: People - name: addresses description: The signed-in member's saved addresses and their default x-fluid-section: People - name: activities description: The signed-in member's activity feed and unread count. x-fluid-section: People - name: contacts description: The signed-in member's contacts. x-fluid-section: People paths: /api/member/v2026-10/contacts: get: tags: - contacts summary: List the member's contacts description: >- The member's contacts in the lite shape: contacts the membership owns (its `member_id`), in this company or with no company recorded, and contacts held by the membership's user (its `user_id`) in this company, regardless of its `member_id`. Either claim is enough, so a contact reassigned to another member of the company stays in the list of the user who still holds it. A contact moved to another company leaves the member's contacts altogether. Last activity and unread state come from maintained counters. The ETag covers the page; the list is not cached (`max-age=0`). operationId: member_contacts_index parameters: - name: If-None-Match in: header required: false description: ETag from a previous response. schema: type: string - name: filter[group_id] in: query required: false description: Only contacts in this group of the member's. schema: type: string format: uuid - name: filter[tag] in: query required: false description: Only contacts in the member's group with this name. schema: type: string example: Hot leads - name: filter[unread] in: query required: false description: >- `true` lists contacts with unread activity. A contact with unread activity whose counter awaits background reconciliation answers 503 rather than being left out. schema: type: boolean example: true - name: filter[updated_since] in: query required: false description: Only contacts changed at or after this time. schema: type: string format: date-time example: '2026-09-01T00:00:00Z' - name: sort in: query required: false description: >- `last_activity_at`, `name` or `created_at`; prefix `-` for descending. Defaults to `-last_activity_at`, contacts without activity last. schema: type: string enum: - last_activity_at - '-last_activity_at' - name - '-name' - created_at - '-created_at' default: '-last_activity_at' example: '-last_activity_at' - name: page[cursor] in: query required: false description: >- Opaque cursor from `meta.pagination.next_cursor`. A cursor issued for other filters, another sort or another member restarts at the first page; a malformed, tampered or expired one (older than three days) returns 400. schema: type: string - name: page[limit] in: query required: false description: Page size. Defaults to 25, at most 100. schema: type: integer minimum: 1 maximum: 100 default: 25 example: 25 responses: '200': description: One page of contacts. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/ContactsEnvelope' example: status: 200 data: - id: 0192f3d1-6a2b-7c3d-8e4f-5a6b7c8d9e01 first_name: Jordan last_name: Lee display_name: Jordan Lee email: jordan.lee@example.com phone: '+15555550142' avatar_url: null status: new source: Spring wellness webinar tags: - Hot leads groups: - 0192f4e5-6f7a-7b8c-9d0e-1f2a3b4c5d67 last_activity_at: '2026-09-29T18:42:07.123456Z' unread_activity: true created_at: '2026-08-14T12:00:00.000000Z' updated_at: '2026-09-29T18:42:07.123456Z' meta: request_uuid: 0192f4c8-5b6c-7d74-a3e8-0f1a2b3c4d5e timestamp: '2026-09-30T15:08:21Z' pagination: next_cursor: null '304': description: >- The representation is unchanged; authentication and ownership are checked before this response. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' '400': description: The pagination cursor is malformed, tampered with or expired. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: >- The credential is a member session JWT, the kind order and subscription email links carry, which cannot read contacts. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: A query parameter is not valid. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '503': description: Contact counters are awaiting background reconciliation. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: headers: ETag: description: >- Fingerprint of this member's representation. Send it back in If-None-Match to skip the body while it is unchanged. schema: type: string CacheControl: description: Standard HTTP Cache-Control directive. Always private for this surface. schema: type: string example: max-age=60, private schemas: ContactsEnvelope: type: object description: One page of contacts. properties: status: type: integer data: type: array items: $ref: '#/components/schemas/ContactSummary' meta: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: pagination: $ref: '#/components/schemas/PaginationMeta' required: - pagination required: - status - data - meta ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object properties: message: type: string description: Human-readable error message. details: type: object additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta ContactSummary: type: object description: A contact in the lite list shape. additionalProperties: false properties: id: type: string format: uuid description: Public contact id. first_name: type: - string - 'null' description: First name. last_name: type: - string - 'null' description: Last name. display_name: type: - string - 'null' description: Full name, falling back to email or phone; null when there is none. email: type: - string - 'null' description: Email address. phone: type: - string - 'null' description: Phone number. avatar_url: type: - string - 'null' description: Avatar image URL. status: type: - string - 'null' description: The member's pipeline status for the contact, such as `new`. source: type: - string - 'null' description: Where the contact came from. tags: type: array items: type: string description: Names of the member's groups the contact is in. groups: type: array items: type: string format: uuid description: Ids of the member's groups the contact is in. last_activity_at: type: - string - 'null' format: date-time description: >- When the newest activity about the contact happened, from a maintained counter; null when there is none. unread_activity: type: boolean description: Whether the contact has unread activity, from a maintained counter. created_at: type: string format: date-time description: When the contact was added. updated_at: type: string format: date-time description: When the contact last changed. required: - id - first_name - last_name - display_name - email - phone - avatar_url - status - source - tags - groups - last_activity_at - unread_activity - created_at - updated_at ResponseMeta: type: object description: Envelope metadata present on every response. properties: request_uuid: type: string format: uuid description: Server-generated UUIDv7 uniquely identifying this response. timestamp: type: string format: date-time description: ISO 8601 timestamp at which the server produced the response. required: - request_uuid - timestamp additionalProperties: true PaginationMeta: type: object description: Keyset pagination state for a list. additionalProperties: false properties: next_cursor: type: - string - 'null' description: Send as `page[cursor]` for the next page; null on the last page. required: - next_cursor securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.