> ## 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 <token>; 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 droplet's status

> The status of your company's live installation of a droplet, else its most recent, with every installation in `history`. Same payload as `GET /droplet-installations/{uuid}/status`. Needs the `developer.view` permission.



## OpenAPI

````yaml /api-reference/company-droplets-v2026-10.yaml get /api/company/v2026-10/droplets/{uuid}/status
openapi: 3.1.0
info:
  title: Fluid Company API v2026-10 — Droplets
  version: 2026-10
  description: >-
    Your company's droplets on v2026-10: the catalog your company can install
    from, the droplets your company publishes, and installing, changing and
    uninstalling one.


    ## Authentication


    Send a company admin credential as `Authorization: Bearer <token>`: an admin
    session token or an API token for your company. Reads need the
    `droplets.view` permission; writes and installs need `droplets.update`.
    Droplet installation tokens are refused, so a droplet cannot rewrite the
    catalog it is listed in.


    ## Responses


    Every response wraps the resource under its own key with `status` and
    `meta`, in the shape of the v2026-04 storefront API:


    ```json

    { "droplet": { "uuid": "drp_…", "title": "Order Sync" }, "status": 200,
    "meta": { "request_id": "…", "timestamp": "…" } }

    ```


    Errors use the same envelope with `error.message` and field-keyed
    `error.details`. A 401 is a bare `{ "message": … }`.


    ## Finding a droplet


    `GET /droplets?q=…` searches what droplets say they do, so look here before
    building one. Lists page by cursor: follow `meta.pagination.next_cursor`
    until it is null.


    ## Showing installed droplets


    `GET /droplet-installations` returns every droplet your company has
    installed with just its uuid, title and logo, for navigation menus and other
    places shown on every page. Open one with `GET /droplets/{uuid}`.


    ## Managing an installation


    `GET /droplet-installations/{uuid}` reads one installation with its droplet,
    role and scopes. `PATCH` changes its role or scopes, and `DELETE` uninstalls
    it: the droplet's credentials are revoked and its uninstall webhook is sent.


    ## Who installed your droplet


    `GET /droplets/{droplet_uuid}/installations` lists the companies that have
    installed a droplet your company publishes, each named by its uuid.


    ## Describing a droplet


    A droplet is described like the rest of the app's resources: a `title`, a
    one-line `summary` for its marketplace card, a longer `description` for its
    details page (HTML: paragraphs, headings, lists, links), a `logo_url`, and
    `features`, each a `title` with an optional `image_url` or `video_url`.
    Upload media to your company's DAM first and use the URLs it gives you.


    ## Publishing a droplet


    Only Fluid publishes a droplet to the public marketplace. When a draft or
    internal droplet is ready, `POST /droplets/{droplet_uuid}/publish-request`
    asks Fluid to review it; the droplet keeps its status, and keeps working for
    the stores that use it, until Fluid decides. Asking again while a request
    waits returns the same request, and `DELETE` withdraws it. Fluid publishes
    the droplet when it approves, or emails why it didn't;
    `latest_publish_review` on the droplet shows where the request stands, with
    the reason once rejected. Every move back to the marketplace, such as after
    Fluid unlists a droplet, is asked for the same way.


    ## Webhook secret


    Fluid signs the webhooks and data requests it sends your droplet with its
    webhook secret. No droplet response carries it. `POST
    /droplets/{uuid}/webhook-secret-rotations` generates a new one and returns
    it once; the old one stops being used immediately.


    ## Checking a droplet's health


    `GET /droplets/{uuid}/health` says how a droplet's callbacks have behaved
    for your company's own installation over a trailing window: each callback it
    answers, whether a checkout waits on it, and its request, failure and
    timeout counts and latency. Read `metrics_available` first: the figures come
    from Fluid's monitoring, so they can be missing (`metrics` null,
    `metrics_error` set) while the installation and its callbacks are listed in
    full. A zero count is a real reading: nothing called that callback in the
    window. `installation` is null when your company publishes the droplet but
    has not installed it. Only your company's installation is ever returned.


    ## What changed from `/api/droplets`


    - A droplet is flat: `title`, `summary`, `description`, `logo_url` and
    `features` replace the `name` and `settings` object, and a feature is its
    `title` and media.

    - `filter[ownership]=owned` replaces `GET /api/droplets/company_droplets`.

    - `publisher` carries the publishing company's `uuid`, not its integer id.

    - A droplet's installations are read by their own uuid at
    `/droplet-installations/{uuid}`, and `PATCH` there does not need `active`.

    - Listing who installed your droplet answers 404, not 401, when the droplet
    is not your company's.

    - `PATCH` changes only what you send.

    - `status` replaces the `active` and `publicly_available` flags, with the
    same rules: anyone with `droplets.update` can take a droplet offline
    (`draft`) or back into service (`internal`); publishing, or unlisting a
    published droplet, needs a Fluid root admin.

    - `DELETE` is refused while another company has the droplet installed.

    - Publishing goes through marketplace review (`POST
    /droplets/{droplet_uuid}/publish-request`) rather than an `active` or
    `publicly_available` flag.
  contact:
    email: support@fluid.app
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.fluid.app
    description: Production API server
security: []
tags:
  - name: droplets
    description: Droplets your company finds, publishes and installs.
    x-fluid-section: Droplets
paths:
  /api/company/v2026-10/droplets/{uuid}/status:
    parameters:
      - name: uuid
        in: path
        required: true
        description: The droplet's uuid, from `uuid` on any droplet.
        schema:
          type: string
        example: drp_4tq8nxw2kfl9mrv3bpz6cyh1jds7age5
    get:
      tags:
        - droplets
      summary: Read a droplet's status
      description: >-
        The status of your company's live installation of a droplet, else its
        most recent, with every installation in `history`. Same payload as `GET
        /droplet-installations/{uuid}/status`. Needs the `developer.view`
        permission.
      operationId: companyDropletStatus
      parameters:
        - name: window_hours
          in: query
          required: false
          description: >-
            The trailing window in hours, 1 to 168, for `sections.metrics` and
            `sections.webhook_health`. Defaults to 24.
          schema:
            type: integer
            minimum: 1
            maximum: 168
          example: 24
      responses:
        '200':
          description: The installation's status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyDropletStatusResponse'
              example:
                droplet_status:
                  generated_at: '2026-10-18T15:32:08Z'
                  window_hours: 24
                  installation:
                    uuid: dri_7hq2mxk4bnv8rlp3ctw6yzd1fgs9aje5
                    status: active
                    droplet:
                      uuid: drp_4tq8nxw2kfl9mrv3bpz6cyh1jds7age5
                      name: Taxify
                    created_at: '2026-10-01T09:00:00Z'
                    updated_at: '2026-10-01T09:00:00Z'
                  history: null
                  sections:
                    deployment:
                      available: true
                      error: null
                      data:
                        hosted: false
                        deployments: []
                    install_status:
                      available: true
                      error: null
                      data:
                        status: active
                        delivery_state: delivered
                    lifecycle:
                      available: true
                      error: null
                      data:
                        deliveries: []
                    health:
                      available: true
                      error: null
                      data:
                        verdict: healthy
                        signals:
                          callback:
                            verdict: healthy
                          breaker:
                            state: closed
                            observed_at: '2026-10-18T15:31:00Z'
                          lifecycle:
                            state: ok
                            observed_at: '2026-10-18T15:30:00Z'
                    metrics:
                      available: true
                      error: null
                      data:
                        window_hours: 24
                        request_count: 120
                        failure_count: 0
                        timeout_count: 0
                        failure_rate: 0
                        average_ms: 84.2
                        worst_p95_ms: 190
                        max_ms: 410
                    webhook_health:
                      available: true
                      error: null
                      data:
                        window_hours: 24
                        verdict: none
                        webhooks:
                          total: 0
                          active: 0
                          events: []
                        deliveries:
                          total: 0
                          succeeded: 0
                          failed: 0
                          pending: 0
                          success_rate: null
                          capped: false
                        recent_failures: []
                        shared_events: []
                    app_hosts:
                      available: true
                      error: null
                      data:
                        hosted: false
                        hosts: []
                        webhooks: []
                        shared_events: []
                        capped: false
                    reconcile:
                      available: false
                      error: null
                      data: null
                    connect:
                      available: false
                      error: null
                      data: null
                status: 200
                meta:
                  request_id: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583
                  timestamp: '2026-10-18T15:32:08Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/StatusForbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
      security:
        - bearer_auth: []
components:
  schemas:
    CompanyDropletStatusResponse:
      type: object
      description: One droplet installation's status.
      required:
        - droplet_status
        - status
        - meta
      properties:
        droplet_status:
          $ref: '#/components/schemas/CompanyDropletStatus'
        status:
          type: integer
        meta:
          $ref: '#/components/schemas/Meta'
    CompanyDropletStatus:
      type: object
      required:
        - generated_at
        - window_hours
        - installation
        - history
        - sections
      properties:
        generated_at:
          type: string
          format: date-time
        window_hours:
          type: integer
          description: >-
            The trailing window `sections.metrics` and `sections.webhook_health`
            cover.
        installation:
          $ref: '#/components/schemas/CompanyDropletStatusInstallation'
        history:
          description: >-
            Every installation your company has made of the droplet, newest
            first. Null when read by installation uuid.
          oneOf:
            - type: 'null'
            - type: array
              items:
                $ref: '#/components/schemas/CompanyDropletStatusInstallation'
        sections:
          $ref: '#/components/schemas/CompanyDropletStatusSections'
    Meta:
      type: object
      description: |
        Response metadata included on every successful response body.
        `request_id` and `timestamp` are always present; list endpoints
        also add `pagination`.
      required:
        - request_id
        - timestamp
      properties:
        request_id:
          type:
            - string
            - 'null'
        timestamp:
          type: string
          format: date-time
        pagination:
          $ref: '#/components/schemas/Pagination'
    UnauthorizedError:
      type: object
      description: |
        Bare 401 body — a single `message` string, not the wrapped
        `ErrorResponse`.
      required:
        - message
      properties:
        message:
          type: string
          example: Invalid credentials.
    ForbiddenError:
      description: |
        Bare 403 body: `{ error }` when a storefront permission is missing,
        or `{ message }` when the credential is not company-admin tier.
      oneOf:
        - type: object
          required:
            - error
          properties:
            error:
              type: string
              example: Not authorized.
        - type: object
          required:
            - message
          properties:
            message:
              type: string
              example: Not authorized.
    ErrorResponse:
      type: object
      required:
        - error
        - status
        - meta
      properties:
        error:
          type: object
          required:
            - message
          properties:
            message:
              type: string
            details:
              type: object
              additionalProperties: true
        status:
          type: integer
        meta:
          $ref: '#/components/schemas/Meta'
    CompanyDropletStatusInstallation:
      type: object
      description: One of your company's installations of a droplet, in any status.
      required:
        - uuid
        - status
        - droplet
        - created_at
        - updated_at
      properties:
        uuid:
          type: string
        status:
          type: string
          enum:
            - active
            - pending_uninstall
            - uninstalled
          description: >-
            The installation's own status. For what to tell a merchant, read
            `sections.install_status`.
        droplet:
          type: object
          required:
            - uuid
            - name
          properties:
            uuid:
              type: string
            name:
              type:
                - string
                - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          description: >-
            For an uninstalled installation, when it last changed, which is when
            it was uninstalled.
    CompanyDropletStatusSections:
      type: object
      required:
        - deployment
        - install_status
        - lifecycle
        - health
        - metrics
        - webhook_health
        - app_hosts
        - reconcile
        - connect
      properties:
        deployment:
          description: >-
            The droplet's Mist app deployments for your company; unavailable
            unless you hold `mist.code`.
          allOf:
            - $ref: '#/components/schemas/CompanyDropletStatusSection'
            - properties:
                data:
                  oneOf:
                    - type: 'null'
                    - type: object
                      required:
                        - hosted
                        - deployments
                      properties:
                        hosted:
                          type: boolean
                          description: >-
                            Whether your company has a Mist app serving the
                            droplet.
                        deployments:
                          type: array
                          items:
                            type: object
                            required:
                              - id
                              - state
                              - url
                              - commit_sha
                              - created_at
                              - target
                            properties:
                              id:
                                type: string
                              state:
                                type: string
                              url:
                                type:
                                  - string
                                  - 'null'
                              commit_sha:
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                type:
                                  - string
                                  - 'null'
                              target:
                                type:
                                  - string
                                  - 'null'
        install_status:
          description: >-
            What to tell the merchant, from the installation's status and its
            latest lifecycle webhook.
          allOf:
            - $ref: '#/components/schemas/CompanyDropletStatusSection'
            - properties:
                data:
                  oneOf:
                    - type: 'null'
                    - $ref: '#/components/schemas/CompanyDropletInstallationLifecycle'
        lifecycle:
          description: >-
            The installation's install and uninstall webhook deliveries, newest
            first.
          allOf:
            - $ref: '#/components/schemas/CompanyDropletStatusSection'
            - properties:
                data:
                  oneOf:
                    - type: 'null'
                    - type: object
                      required:
                        - deliveries
                      properties:
                        deliveries:
                          type: array
                          items:
                            type: object
                            required:
                              - event
                              - trigger
                              - state
                              - attempts
                              - last_status
                              - last_error_category
                              - created_at
                              - updated_at
                            properties:
                              event:
                                type: string
                                enum:
                                  - installed
                                  - uninstalled
                              trigger:
                                type: string
                                enum:
                                  - install
                                  - uninstall
                                  - retry
                              state:
                                type: string
                                enum:
                                  - pending
                                  - enqueue_failed
                                  - retrying
                                  - delivered
                                  - rejected
                                  - exhausted
                              attempts:
                                type: integer
                              last_status:
                                type:
                                  - integer
                                  - 'null'
                              last_error_category:
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                type: string
                                format: date-time
                              updated_at:
                                type: string
                                format: date-time
        health:
          description: >-
            The installation's health rollup, with its verdict and signals
            including the circuit breaker.
          allOf:
            - $ref: '#/components/schemas/CompanyDropletStatusSection'
            - properties:
                data:
                  oneOf:
                    - type: 'null'
                    - type: object
                      required:
                        - verdict
                        - signals
                      properties:
                        verdict:
                          type: string
                          enum:
                            - healthy
                            - degraded
                            - failing
                            - idle
                            - unknown
                          description: >-
                            This installation's callback verdict worsened by its
                            circuit breaker, from the health rollup and
                            independent of `window_hours`. A stale or missing
                            rollup reads `unknown`.
                        signals:
                          type: object
                          required:
                            - callback
                            - breaker
                            - lifecycle
                          properties:
                            callback:
                              type: object
                              required:
                                - verdict
                              properties:
                                verdict:
                                  type: string
                                  enum:
                                    - healthy
                                    - degraded
                                    - failing
                                    - idle
                                    - unknown
                            breaker:
                              $ref: >-
                                #/components/schemas/CompanyDropletStatusStateSignal
                            lifecycle:
                              $ref: >-
                                #/components/schemas/CompanyDropletStatusStateSignal
        metrics:
          description: >-
            Every callback of this installation together over `window_hours`;
            unavailable when New Relic cannot be read.
          allOf:
            - $ref: '#/components/schemas/CompanyDropletStatusSection'
            - properties:
                data:
                  oneOf:
                    - type: 'null'
                    - type: object
                      required:
                        - window_hours
                        - request_count
                        - failure_count
                        - timeout_count
                        - failure_rate
                        - average_ms
                        - worst_p95_ms
                        - max_ms
                      properties:
                        window_hours:
                          type: integer
                        request_count:
                          type: integer
                        failure_count:
                          type: integer
                        timeout_count:
                          type: integer
                        failure_rate:
                          type: number
                        average_ms:
                          type:
                            - number
                            - 'null'
                        worst_p95_ms:
                          type:
                            - number
                            - 'null'
                        max_ms:
                          type:
                            - number
                            - 'null'
        webhook_health:
          description: >-
            The installation's ordinary event webhooks, kept apart from
            lifecycle delivery.
          allOf:
            - $ref: '#/components/schemas/CompanyDropletStatusSection'
            - properties:
                data:
                  oneOf:
                    - type: 'null'
                    - type: object
                      required:
                        - window_hours
                        - verdict
                        - webhooks
                        - deliveries
                        - recent_failures
                        - shared_events
                      properties:
                        window_hours:
                          type: integer
                        verdict:
                          type: string
                          enum:
                            - none
                            - ambiguous
                            - healthy
                            - attention
                            - failing
                          description: >-
                            `none` when the installation has no webhooks.
                            `ambiguous` when every event it takes is shared with
                            another of your webhooks, so no delivery can be
                            attributed to it. `failing` when its last three
                            settled deliveries failed or under 80% of settled
                            deliveries succeeded.
                        webhooks:
                          type: object
                          required:
                            - total
                            - active
                            - events
                          properties:
                            total:
                              type: integer
                            active:
                              type: integer
                            events:
                              type: array
                              items:
                                type: string
                        deliveries:
                          type: object
                          required:
                            - total
                            - succeeded
                            - failed
                            - pending
                            - success_rate
                            - capped
                          properties:
                            total:
                              type: integer
                            succeeded:
                              type: integer
                            failed:
                              type: integer
                            pending:
                              type: integer
                            success_rate:
                              type:
                                - number
                                - 'null'
                            capped:
                              type: boolean
                              description: >-
                                True when the window held more deliveries than
                                were counted.
                        recent_failures:
                          type: array
                          items:
                            type: object
                            required:
                              - id
                              - event
                              - status
                              - at
                            properties:
                              id:
                                type: string
                              event:
                                type: string
                              status:
                                type:
                                  - string
                                  - 'null'
                              at:
                                type: string
                                format: date-time
                        shared_events:
                          type: array
                          items:
                            type: string
                          description: >-
                            Events another active webhook of your company also
                            takes. Deliveries are matched by event name, so
                            these counts may include the other webhook's
                            deliveries.
        app_hosts:
          description: >-
            Which of your company's webhooks deliver to the Mist app's hosts;
            unavailable unless you hold `mist.code`.
          allOf:
            - $ref: '#/components/schemas/CompanyDropletStatusSection'
            - properties:
                data:
                  oneOf:
                    - type: 'null'
                    - type: object
                      required:
                        - hosted
                        - hosts
                        - webhooks
                        - shared_events
                        - capped
                      properties:
                        hosted:
                          type: boolean
                        hosts:
                          type: array
                          items:
                            type: string
                        webhooks:
                          type: array
                          items:
                            type: object
                            required:
                              - event
                              - active
                              - url
                            properties:
                              event:
                                type:
                                  - string
                                  - 'null'
                              active:
                                type: boolean
                              url:
                                type:
                                  - string
                                  - 'null'
                                description: Origin and path only.
                        shared_events:
                          type: array
                          items:
                            type: string
                        capped:
                          type: boolean
                          description: >-
                            True when your company has more webhooks than were
                            matched.
        reconcile:
          $ref: '#/components/schemas/CompanyDropletStatusSection'
          description: Not built yet. Always `available` false.
        connect:
          $ref: '#/components/schemas/CompanyDropletStatusSection'
          description: Not built yet. Always `available` false.
    Pagination:
      type: object
      required:
        - cursor
        - limit
        - prev_cursor
        - next_cursor
      properties:
        cursor:
          type:
            - string
            - 'null'
        limit:
          type: integer
          example: 25
        prev_cursor:
          type:
            - string
            - 'null'
        next_cursor:
          type:
            - string
            - 'null'
    CompanyDropletStatusSection:
      type: object
      description: >-
        One part of the status. Each part is read on its own, so one that fails
        does not hide the others.
      required:
        - available
        - error
        - data
      properties:
        available:
          type: boolean
          description: >-
            False when the part could not be read, and for `reconcile` and
            `connect`, which are not built yet.
        error:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/CompanyDropletStatusError'
        data:
          type:
            - object
            - 'null'
    CompanyDropletInstallationLifecycle:
      type: object
      description: >-
        What to tell the merchant about an installation, from its status and the
        latest lifecycle webhook delivery.
      required:
        - status
        - delivery_state
      properties:
        status:
          type: string
          enum:
            - active
            - needs_attention
            - uninstalling
            - failed
            - uninstalled
          description: >-
            `needs_attention`: active, but the install webhook was rejected,
            exhausted its retries or could not be queued. `failed`: the
            uninstall webhook was rejected, exhausted its retries or could not
            be queued while the installation is still `pending_uninstall`. A
            rejected or exhausted uninstall is finalized anyway, so the
            installation then reads `uninstalled`; one whose webhook could not
            be queued stays `pending_uninstall` until the uninstall is requested
            again.
        delivery_state:
          type: string
          enum:
            - unknown
            - pending
            - enqueue_failed
            - retrying
            - delivered
            - rejected
            - exhausted
          description: The latest delivery's state, `unknown` when none was recorded.
    CompanyDropletStatusStateSignal:
      type: object
      required:
        - state
        - observed_at
      properties:
        state:
          type: string
          description: The signal's state; `unknown` when the reading is stale or absent.
        observed_at:
          type:
            - string
            - 'null'
          format: date-time
    CompanyDropletStatusError:
      type: object
      description: >-
        Why a section could not be read. A fixed category and sentence, never a
        provider's own text.
      required:
        - type
        - description
      properties:
        type:
          type: string
          enum:
            - unavailable
            - incomplete
        description:
          type: string
  responses:
    Unauthorized:
      description: >-
        Missing or invalid bearer token. The body is a bare `{ message }`, not
        the error envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorizedError'
          example:
            message: Invalid credentials.
    StatusForbidden:
      description: >-
        Not a company admin with the needed permissions (bare body), or a
        droplet installation token (the error envelope).
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/ForbiddenError'
              - $ref: '#/components/schemas/ErrorResponse'
          example:
            message: Not authorized.
    NotFound:
      description: >-
        No such droplet for your company. Another company's private droplet, and
        on writes another company's droplet of any status, read as missing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              message: Droplet not found
              details: {}
            status: 404
            meta:
              request_id: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583
              timestamp: '2026-10-18T15:32:08Z'
    UnprocessableEntity:
      description: Invalid parameters, or a write the droplet refused.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              message: Invalid parameters
              details:
                droplet:
                  name:
                    - is missing
            status: 422
            meta:
              request_id: 7e2c9b41-3f8a-4d15-b6e0-9a4c21d7f583
              timestamp: '2026-10-18T15:32:08Z'
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: >-
        A company admin credential for your company. Droplet installation tokens
        are refused.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.