> ## 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, run `fluid signup` from the Fluid CLI, or 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. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token. > 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 on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors. > 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 except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — 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. # Read a team member's Exigo figures > Opens someone in the member's team, by the Exigo customer id a team list's people carry, for summary, team and activity. The connector refuses anyone outside the member's downline (`exigo.status` is `not_in_team`, 404), and reading anyone other than yourself needs a rep member, company admin or root admin. The member's own id reads as their own figures. Earnings and the plan are only ever the member's own. The answer is shaped like the member's own, and the figures name whose they are (`customer_id`) and the chain from the member to them (`path`). A team member who keeps their earnings private appears as `Private Member` with no estimated payout. ## OpenAPI ````yaml /api-reference/member-exigo-v2026-10.yaml get /api/member/v2026-10/exigo/team/{exigo_id}/{operation} openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Exigo member data description: > A member's figures from the Exigo compensation plan their company runs: titles, volumes, estimated payouts, commissions, payouts, the company's title ladders, the people in their team and their recent activity. Every operation acts as the member the bearer credential speaks for; the member and their company come from the credential alone, and their own Exigo customer id is read from their membership, never from the request. A `team/{exigo_id}` path (or the older `of` query parameter) only picks a person inside that member's own downline to read; it can't switch to another member's account, and a credential for another company or member can only ever reach its own figures and downline. **Who can read what.** A member reads their own figures when their membership is rep-eligible; a `team/{exigo_id}` path naming the member's own id is that same read. Reading anyone else's figures, which is the team list and a `team/{exigo_id}` operation for someone in their downline, needs a rep member, a company admin or a root admin; a membership that is only rep-eligible is refused with `403`. Opening a person who is not in the member's downline answers `404` with the status `not_in_team`. The feature is off until the company turns on Exigo member data, and every operation answers `404` until then. **The envelope.** Every answer, including one with no figures, carries an `exigo` object holding the `operation`, a `status`, how fresh the figures are and the `figures` themselves. The HTTP code follows the `status`: `200` for `ready`, `503` for `unavailable` (with `Retry-After`), and `404` for every status that means there is nothing to read. The `figures` are `null` unless the status is `ready`. **Freshness.** `as_of` is when the figures were read from Exigo, in UTC. A cached answer keeps the time of the read it holds, not the time of the request. `stale` says whether the figures are an older copy served because Exigo could not answer. `is_estimate` says whether they are still moving: it is `true` for a summary, team or earnings answer whose month has not ended. **Figures that vary by company.** The `volumes`, `pending` and `estimates` sections are maps whose keys are the figures the company's Exigo mapping defines, so they differ from company to company. Read the keys from the response rather than assuming a set, and use the `labels` object, which carries the company's own name for each key, to show them. **Caching.** Responses are private to the caller and are never reusable from a cache (`Cache-Control: private, no-store`). **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted, every operation refuses a credential for it with `403` and the standard error envelope, before the operation runs. 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: exigo description: >- The signed-in member's figures from their company's Exigo compensation plan, and those of the people in their team. x-fluid-section: Members paths: /api/member/v2026-10/exigo/team/{exigo_id}/{operation}: get: tags: - exigo summary: Read a team member's Exigo figures description: >- Opens someone in the member's team, by the Exigo customer id a team list's people carry, for summary, team and activity. The connector refuses anyone outside the member's downline (`exigo.status` is `not_in_team`, 404), and reading anyone other than yourself needs a rep member, company admin or root admin. The member's own id reads as their own figures. Earnings and the plan are only ever the member's own. The answer is shaped like the member's own, and the figures name whose they are (`customer_id`) and the chain from the member to them (`path`). A team member who keeps their earnings private appears as `Private Member` with no estimated payout. operationId: member_exigo_team_member_show parameters: - name: exigo_id in: path required: true description: >- Exigo customer id of someone in the member's team, as a team list's `customer_id`. schema: type: string pattern: ^[1-9]\d{0,9}$ - name: operation in: path required: true description: The operation to read for that person. schema: type: string enum: - summary - team - activity - $ref: '#/components/parameters/Period' - $ref: '#/components/parameters/TeamPage' - $ref: '#/components/parameters/TeamType' responses: '200': description: The figures of the person opened. Their shape follows the operation. headers: Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/ExigoEnvelope' example: status: 200 exigo: operation: activity status: ready as_of: '2026-10-21T15:04:05Z' stale: false is_estimate: false figures: operation: activity customer_id: 4388 path: - customer_id: 4021 name: Sam Example private: false - customer_id: 4388 name: Alex Sample private: false recent: - kind: order date: '2026-10-12' order_id: 90210 currency: usd amount: 84.5 - kind: enrollment date: '2026-09-29' customer_id: 6150 customer_type: affiliate name: Jordan Placeholder private: false - kind: title date: '2026-08-01' track: circle title: Silver metrics: months_active: 14 avg_order_value: 91.25 avg_order_currency: usd growth_trend: 0.04 retention_rate: 0.83 meta: request_uuid: 01a0f4fe-de00-75b3-8d8a-b74b0cde8b07 timestamp: '2026-10-21T15:04:05Z' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: >- There is nothing to read. Either the company has not turned on Exigo member data, or the operation or Exigo id is malformed (an error envelope); or there are no figures (`exigo.status` is `not_configured`, `no_exigo_id`, `member_not_found` or `not_in_team`, and `figures` is `null`). headers: Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: oneOf: - $ref: '#/components/schemas/ExigoEnvelope' - $ref: '#/components/schemas/ErrorEnvelope' example: status: 404 exigo: operation: summary status: not_in_team as_of: null stale: false is_estimate: false figures: null meta: request_uuid: 01a0f4fe-de00-75b3-8d8a-b74b0cde8b07 timestamp: '2026-10-21T15:04:05Z' '422': $ref: '#/components/responses/Invalid' '503': $ref: '#/components/responses/Unavailable' components: parameters: Period: name: period in: query description: >- Month to read, as YYYY-MM. Defaults to the current month in the company's Exigo timezone. Accepted only for summary, team and earnings; plan accepts no query parameters. schema: type: string pattern: ^\d{4}-(0[1-9]|1[0-2])$ example: 2026-10 TeamPage: name: page in: query description: >- Page of the team list, 25 per page, from 1 to 1000. Accepted for team. On the member's own earnings it pages both the ledger and the payouts, an older form kept for existing clients; use `ledger_page` and `payouts_page` instead. schema: type: string pattern: ^([1-9]\d{0,2}|1000)$ example: '2' TeamType: name: type in: query description: Limit the team list to affiliates or customers. Accepted only for team. schema: type: string enum: - affiliate - customer headers: CacheControl: description: >- Standard HTTP Cache-Control directive. Exigo figures are private to the caller and never reusable from a cache. schema: type: string example: private, no-store RetryAfter: description: Seconds to wait before asking again. schema: type: string example: '60' schemas: ExigoEnvelope: type: object description: The envelope every Exigo answer is in, with or without figures. properties: status: type: integer description: HTTP status code (mirrors the response status line). exigo: $ref: '#/components/schemas/ExigoReading' meta: $ref: '#/components/schemas/ResponseMeta' required: - status - exigo - meta ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object description: The error message and details. properties: message: type: string description: Human-readable error message. details: type: object description: Further detail about the error; may be empty. additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta ExigoReading: type: object description: One operation's answer, with how fresh it is. additionalProperties: false properties: operation: type: string description: The operation answered. enum: - summary - team - earnings - plan - activity status: type: string description: >- `ready` when figures are present; `not_configured` when the company has no Exigo connector or mapping; `no_exigo_id` when the member has no numeric Exigo id; `member_not_found` when Exigo has no such customer; `not_in_team` when the opened person is not in the member's downline; `unavailable` when Exigo or the connector could not answer. enum: - ready - not_configured - no_exigo_id - member_not_found - not_in_team - unavailable as_of: type: - string - 'null' format: date-time description: >- When the figures were read from Exigo, in UTC. A cached answer keeps the time of the read it holds, not the time of the request. Null when there are no figures. stale: type: boolean description: >- Whether the figures are an older copy served because Exigo could not answer. Always false for now; no last-good copy is kept yet. is_estimate: type: boolean description: >- Whether the figures are still moving. True for a summary, team or earnings answer whose month has not ended; false for a closed month, for plan and activity, and when there are no figures. figures: description: >- The operation's figures, or null unless the status is `ready`. Its shape follows `operation`. oneOf: - type: 'null' - $ref: '#/components/schemas/ExigoSummary' - $ref: '#/components/schemas/ExigoTeam' - $ref: '#/components/schemas/ExigoEarnings' - $ref: '#/components/schemas/ExigoPlan' - $ref: '#/components/schemas/ExigoActivity' required: - operation - status - as_of - stale - is_estimate - figures 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 ExigoSummary: type: object description: >- A person's titles, volumes and estimated payout for a month. The figures of the `summary` operation. properties: operation: type: string description: Always `summary`. const: summary customer_id: type: integer description: The Exigo customer id these figures are for. path: $ref: '#/components/schemas/ExigoPath' period: $ref: '#/components/schemas/ExigoPeriod' titles: $ref: '#/components/schemas/ExigoTitles' volumes: $ref: '#/components/schemas/ExigoVolumes' pending: $ref: '#/components/schemas/ExigoPending' labels: $ref: '#/components/schemas/ExigoLabels' title_tracks: description: >- The circle and team titles as a list, in that order, each with the title paid this period and the highest reached. The team track carries the company's own names for the two when its mapping has them. The same titles are in `titles`. type: array items: $ref: '#/components/schemas/ExigoTitleTrack' estimated_payout: $ref: '#/components/schemas/ExigoEstimatedPayout' teams: description: >- Exigo customer ids leading the member's teams, largest first. The first is the Support team; the others are Focus teams. type: array items: type: integer team_leaders: description: >- The people leading the teams, one per entry of `teams` and in the same order. Present only for a member who may read the team list (a rep member, company admin or root admin); a member who is only rep-eligible gets their summary without it, and `teams` is unchanged. type: array items: $ref: '#/components/schemas/ExigoTeamLeader' required: - operation - customer_id - period - titles - volumes ExigoTeam: type: object description: >- A page of the people directly below a person. The figures of the `team` operation. properties: operation: type: string description: Always `team`. const: team customer_id: type: integer description: The Exigo customer id whose team this is. period: $ref: '#/components/schemas/ExigoPeriod' path: $ref: '#/components/schemas/ExigoPath' page: type: integer description: The page returned. per_page: type: integer description: People per page. total: type: integer description: People in the whole list. labels: $ref: '#/components/schemas/ExigoLabels' active: type: integer description: People in the list who bought this period. type: type: - string - 'null' enum: - affiliate - customer - null description: The type the list was limited to, or null for both. people: type: array description: The people on this page. items: $ref: '#/components/schemas/ExigoTeamPerson' required: - operation - customer_id - period - page - per_page - total - people ExigoEarnings: type: object description: >- The member's commissions, payouts and adjustments. The figures of the `earnings` operation. properties: operation: type: string description: Always `earnings`. const: earnings customer_id: type: integer description: The Exigo customer id these figures are for. path: $ref: '#/components/schemas/ExigoPath' period: $ref: '#/components/schemas/ExigoPeriod' estimates: $ref: '#/components/schemas/ExigoEstimates' labels: $ref: '#/components/schemas/ExigoLabels' ledger: type: object description: A page of the commission ledger, newest run first. properties: page: type: integer description: The page returned. per_page: type: integer description: Entries per page. total: type: integer description: Entries in the whole ledger. entries: type: array description: The entries on this page. items: type: object description: One commission run's earnings. properties: run_id: type: integer description: The commission run's id. description: type: - string - 'null' description: The run's description. kind: type: string description: >- Whether the run is a daily or monthly run, or another kind. enum: - daily - monthly - other run_date: type: - string - 'null' format: date description: The date of the run. currency: type: - string - 'null' description: The currency code of the amounts. earnings: $ref: '#/components/schemas/ExigoMoney' total: $ref: '#/components/schemas/ExigoMoney' required: - run_id - description - kind - run_date - currency - earnings - total required: - page - per_page - total - entries payouts: type: object description: A page of the payouts made to the member, newest first. properties: page: type: integer description: The page returned. per_page: type: integer description: Entries per page. total: type: integer description: Payouts in the whole list. entries: type: array description: The payouts on this page. items: type: object description: One payout. properties: payout_id: type: integer description: The payout's id. date: type: - string - 'null' format: date description: The payout date. type: type: - string - 'null' description: How the payout was made. currency: type: - string - 'null' description: The currency code of the amount. amount: $ref: '#/components/schemas/ExigoMoney' required: - payout_id - date - type - currency - amount required: - page - per_page - total - entries adjustments: description: >- Manual adjustment lines from the counted commission runs, newest first (at most 25). Each is also inside its run's ledger total. type: array items: type: object description: One manual adjustment. properties: run_id: type: integer description: The commission run's id. run_description: type: - string - 'null' description: The run's description. run_date: type: - string - 'null' format: date description: The date of the run. kind: type: string description: Always `adjustment`. const: adjustment description: type: - string - 'null' description: The adjustment's description. currency: type: - string - 'null' description: The currency code of the amount. amount: $ref: '#/components/schemas/ExigoMoney' required: - run_id - run_description - run_date - kind - description - currency - amount monthly_history: description: What the member earned in each of the recent months. type: array items: type: object description: One month's earnings. properties: id: type: integer description: Exigo's id for the period. name: type: - string - 'null' description: The period's name. start: type: string format: date description: First day of the period. end: type: string format: date description: Last day of the period. circle: $ref: '#/components/schemas/ExigoMoney' team: $ref: '#/components/schemas/ExigoMoney' other: $ref: '#/components/schemas/ExigoMoney' total: $ref: '#/components/schemas/ExigoMoney' required: - id - name - start - end - circle - team - other - total required: - operation - customer_id - period - estimates - ledger - payouts - monthly_history ExigoPlan: type: object description: >- The company's title ladders, the same for every member. The figures of the `plan` operation. properties: operation: type: string description: Always `plan`. const: plan customer_id: type: integer description: The Exigo customer id that asked. path: $ref: '#/components/schemas/ExigoPath' circle_titles: description: >- Circle titles from the first up, with the minimum volume and plan terms for each. type: array items: type: object description: One circle title. properties: rank_id: type: integer description: Exigo's id for the title. title: type: - string - 'null' description: The title's name. min_volume: type: number description: The minimum circle volume to reach the title. rate: type: number description: The commission rate the title pays, as a fraction. product_credit: type: - number - 'null' description: The product credit the title earns, if any. guarantee: type: - number - 'null' description: The guaranteed payout the title earns, if any. one_time_bonus: type: - number - 'null' description: The one-time bonus for first reaching the title, if any. required: - rank_id - title - min_volume - rate team_titles: description: >- Team titles from the first up, with the pay volume and leg requirements for each and the plan terms the company has for it (null when none). type: array items: type: object description: One team title. properties: rank_id: type: integer description: Exigo's id for the title. title: type: - string - 'null' description: The title's name. min_pay_volume: type: - number - 'null' description: The minimum pay volume to reach the title. leg_requirements: type: object description: >- The volume required from the team's legs, keyed by the leg requirement the plan defines. additionalProperties: type: - number - 'null' rate: type: - number - 'null' description: The commission rate the title pays, as a fraction. required_premier_teams: type: - integer - 'null' description: How many premier teams the title requires. bonus: type: - number - 'null' description: The bonus the title earns, if any. required: - rank_id - title - min_pay_volume - leg_requirements - rate - required_premier_teams - bonus required: - operation - circle_titles - team_titles ExigoActivity: type: object description: >- A person's recent orders, enrollments and titles, with performance metrics. The figures of the `activity` operation. properties: operation: type: string description: Always `activity`. const: activity customer_id: type: integer description: The Exigo customer id these figures are for. path: $ref: '#/components/schemas/ExigoPath' recent: description: >- The person's last orders, new direct enrollees and titles reached over the last 12 months, newest first, at most 10. A title counts when a month's pay title beats every earlier month in the window. type: array items: type: object description: One recent event. Which fields are present depends on `kind`. properties: kind: type: string description: What happened. enum: - order - enrollment - title date: type: - string - 'null' format: date description: When it happened. order_id: type: integer description: The order's id (order). currency: type: - string - 'null' description: The currency code of the amount (order). amount: $ref: '#/components/schemas/ExigoMoney' customer_id: type: integer description: The new enrollee's Exigo customer id (enrollment). customer_type: type: string description: >- Whether the new enrollee is an affiliate or a customer (enrollment). enum: - affiliate - customer name: type: - string - 'null' description: >- The new enrollee's name from the company's member records; `Private Member` when they keep it private (enrollment). private: type: boolean description: >- Whether the new enrollee keeps their name private (enrollment). track: type: string description: The track the title is on (title). enum: - circle - team title: type: - string - 'null' description: The title reached (title). required: - kind - date metrics: description: >- Performance metrics. `growth_trend` is the change in circle volume between the two latest complete months and `retention_rate` the share of direct people who bought in the earlier of them and again in the later one, both as fractions; null when there is nothing to compare. type: object properties: months_active: type: - integer - 'null' description: Months the person has been active. avg_order_value: $ref: '#/components/schemas/ExigoMoney' description: Average counted order over the window, in `avg_order_currency`. avg_order_currency: type: - string - 'null' description: The currency of the latest order; others are not blended in. growth_trend: type: - number - 'null' description: >- The change in circle volume between the two latest complete months, as a fraction. retention_rate: type: - number - 'null' description: >- The share of direct people who bought in the earlier month and again in the later one. required: - months_active - avg_order_value - growth_trend - retention_rate required: - operation - customer_id - recent - metrics ExigoPath: description: >- The chain from the member down to the person these figures are for, member first. A single entry when the member reads their own. type: array items: type: object properties: customer_id: type: integer description: The person's Exigo customer id. name: type: - string - 'null' description: >- Name from the company's member records; `Private Member` for a team member who keeps it private; null when Fluid has no single member with this Exigo id. private: type: boolean description: >- Whether this team member keeps their name and earnings private (never the member themselves). required: - customer_id - name - private ExigoPeriod: description: The month the figures cover, or null for an operation that has none. oneOf: - type: 'null' - type: object properties: id: type: integer description: Exigo's id for the period. name: type: - string - 'null' description: The period's name. start: type: string format: date description: First day of the period. end: type: string format: date description: Last day of the period. required: - id - name - start - end ExigoTitles: type: object description: The titles a person holds on each track. properties: circle_pay: type: - string - 'null' description: The circle title paid this period. circle_highest: type: - string - 'null' description: The highest circle title reached. team_pay: type: - string - 'null' description: >- The team title paid. Filled only by the monthly commission run, so null mid-month. team_highest: type: - string - 'null' description: The highest team title reached. required: - circle_pay - circle_highest - team_pay - team_highest ExigoVolumes: description: >- The company's volume figures, keyed by the names its Exigo mapping defines, so the keys differ from company to company. A figure the company has no data for is null. Read each key's name from `labels.volumes`. type: object additionalProperties: type: - number - 'null' ExigoPending: description: >- Volume still scheduled this period (subscriptions), keyed like `volumes`. Every value is null outside the current period. Read each key's name from `labels.pending`. type: object additionalProperties: type: - number - 'null' ExigoLabels: description: >- The company's own name for each key of `volumes`, `pending` and `estimates`, grouped like the figures they name. A key without a label is absent. Read from the stored mapping on every request, so an edit shows without waiting on the figures cache. type: object properties: volumes: description: Labels of the keys of `volumes`. type: object additionalProperties: type: string pending: description: Labels of the keys of `pending`. type: object additionalProperties: type: string estimates: description: Labels of the keys of `estimates` (earnings only). type: object additionalProperties: type: string ExigoTitleTrack: type: object description: One title track with the title paid this period and the highest reached. properties: track: type: string description: Which track this is. enum: - circle - team label: type: string description: The track's name. paid_as: type: - string - 'null' description: The title paid this period. highest: type: - string - 'null' description: The highest title reached. paid_as_label: type: string description: >- The company's name for the paid-as title; team track only, and only when the mapping labels it. highest_label: type: string description: >- The company's name for the highest title; team track only, and only when the mapping labels it. required: - track - label - paid_as - highest ExigoEstimatedPayout: description: >- This month's estimated payout split into circle, team and total; null for a team member who keeps their earnings private. type: - object - 'null' additionalProperties: $ref: '#/components/schemas/ExigoMoney' ExigoTeamLeader: type: object description: A person leading one of the member's teams. properties: id: type: integer description: The leader's Exigo customer id. name: type: - string - 'null' description: >- Name from the company's member records; `Private Member` for a leader who keeps it private; null when Fluid has no single member with this Exigo id. title: type: - string - 'null' description: >- The leader's title as the connector reports it; null when the connector sends none. private: type: boolean description: >- Whether this leader keeps their name and earnings private (never the member themselves). required: - id - name - title - private ExigoTeamPerson: type: object description: One person in a team list. properties: customer_id: type: integer description: The person's Exigo customer id. Send it as `exigo_id` to open them. customer_type: type: string description: Whether the person is an affiliate or a customer. enum: - affiliate - customer name: type: - string - 'null' description: >- Name from the company's member records; `Private Member` when they keep it private; null when Fluid has no member with this Exigo id. private: type: boolean description: >- Whether they keep their name and earnings private; their `estimated_payout` is then null. circle_pay_title: type: - string - 'null' description: The circle title paid this period. titles: $ref: '#/components/schemas/ExigoTitles' subscribed: type: boolean description: Whether the person has an active subscription. volumes: $ref: '#/components/schemas/ExigoVolumes' pending: $ref: '#/components/schemas/ExigoPending' estimated_payout: $ref: '#/components/schemas/ExigoEstimatedPayout' required: - customer_id - customer_type - name - private - circle_pay_title - subscribed - volumes ExigoEstimates: description: >- This month's estimated earnings by component, keyed by the names the company's mapping defines, plus a total. Read each key's name from `labels.estimates`. type: object additionalProperties: $ref: '#/components/schemas/ExigoMoney' ExigoMoney: description: An amount in the person's currency, or null when there is none. type: - number - 'null' responses: Unauthorized: description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: status: 401 error: message: A member credential is required details: error: unauthorized meta: request_uuid: 01a0f4fe-de00-75b3-8d8a-b74b0cde8b07 timestamp: '2026-10-21T15:04:05Z' Forbidden: description: >- The credential cannot read this. It is the shopper session JWT that order and subscription email links carry; or the membership is not rep-eligible; or the request reads the team list or another person's figures and the membership is not a rep member, company admin or root admin; or the credential is for a sandbox test company that cannot be reached. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: status: 403 error: message: Widget is unavailable for this membership details: {} meta: request_uuid: 01a0f4fe-de00-75b3-8d8a-b74b0cde8b07 timestamp: '2026-10-21T15:04:05Z' Invalid: description: >- A query parameter this operation does not accept, or a value of the wrong shape. The message says which kind. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: status: 422 error: message: Query parameters are not supported details: {} meta: request_uuid: 01a0f4fe-de00-75b3-8d8a-b74b0cde8b07 timestamp: '2026-10-21T15:04:05Z' Unavailable: description: >- Exigo or the connector could not answer (`exigo.status` is `unavailable`, `figures` is `null`). Ask again after `Retry-After` seconds. headers: Retry-After: $ref: '#/components/headers/RetryAfter' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/ExigoEnvelope' example: status: 503 exigo: operation: summary status: unavailable as_of: null stale: false is_estimate: false figures: null meta: request_uuid: 01a0f4fe-de00-75b3-8d8a-b74b0cde8b07 timestamp: '2026-10-21T15:04:05Z' securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company. A member session JWT, the kind order and subscription email links carry, is refused with 403. A company admin's own credential is not a member credential and gets 401. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.