> ## Documentation Index
> Fetch the complete documentation index at: https://getfloo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get App Status

> Say whether a commit is live on dev and, when it is not, why and what to do.



## OpenAPI

````yaml https://api.getfloo.com/openapi.json get /v1/apps/{app_id}/status
openapi: 3.1.0
info:
  title: floo API
  version: 0.1.0
servers:
  - url: https://api.getfloo.com
security: []
paths:
  /v1/apps/{app_id}/status:
    get:
      tags:
        - apps
      summary: Get App Status
      description: >-
        Say whether a commit is live on dev and, when it is not, why and what to
        do.
      operationId: apps_get_app_status
      parameters:
        - name: app_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: App Id
        - name: commit
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                pattern: ^[0-9a-f]{40}$
              - type: 'null'
            description: >-
              Full 40-character Git commit SHA (`git rev-parse HEAD`). The
              status says whether this commit is live on dev, or why not. Leave
              it out for the newest dev deploy.
            title: Commit
          description: >-
            Full 40-character Git commit SHA (`git rev-parse HEAD`). The status
            says whether this commit is live on dev, or why not. Leave it out
            for the newest dev deploy.
        - $ref: '#/components/parameters/X-Floo-Org-Id'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppDeployStatus'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  parameters:
    X-Floo-Org-Id:
      name: X-Floo-Org-Id
      in: header
      required: false
      schema:
        type: string
        format: uuid
      description: Organization to act in; defaults to the one joined most recently.
  schemas:
    AppDeployStatus:
      properties:
        app:
          type: string
          title: App
        source:
          anyOf:
            - $ref: '#/components/schemas/AppSource'
            - type: 'null'
          description: >-
            Where the app's code lives: a push to `branch` of `repo` deploys
            dev. Null when the app has no code source yet.
        commit:
          anyOf:
            - type: string
            - type: 'null'
          title: Commit
          description: The commit asked about, if any.
        live:
          type: boolean
          title: Live
          description: True when `deploy` is the deploy dev serves now.
        summary:
          type: string
          title: Summary
          description: One sentence on where the commit or app stands.
        next_step:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Step
          description: What to do next; null when nothing is needed.
        next:
          anyOf:
            - $ref: '#/components/schemas/NextStep'
            - type: 'null'
          description: >-
            `next_step` as the call to make from the CLI (`cli`), raw HTTP
            (`api`) or an MCP client (`mcp`). Null when nothing is needed, or
            when the step is a person's to take.
        deploy:
          anyOf:
            - $ref: '#/components/schemas/DeployResponse'
            - type: 'null'
        serving:
          anyOf:
            - $ref: '#/components/schemas/ServingDeploy'
            - type: 'null'
        last_push:
          anyOf:
            - $ref: '#/components/schemas/GitHubLastPush'
            - type: 'null'
      type: object
      required:
        - app
        - source
        - commit
        - live
        - summary
        - next_step
        - next
        - deploy
        - serving
        - last_push
      title: AppDeployStatus
      description: >-
        One read that answers "is my change live on dev?" and names the next
        step.


        ``deploy`` is the dev deploy of ``commit``, or the newest dev deploy
        when no

        commit was asked about. With no deploy, ``last_push`` says what floo did
        with

        the last push it saw, so a push that did not deploy is explained.
    ErrorResponse:
      properties:
        detail:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - detail
      title: ErrorResponse
      description: Body of every error response except request validation (422).
    AppSource:
      properties:
        kind:
          $ref: '#/components/schemas/AppSourceKind'
        repo:
          type: string
          title: Repo
        branch:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch
      type: object
      required:
        - kind
        - repo
        - branch
      title: AppSource
      description: |-
        Where an app's code lives: a push to ``branch`` of ``repo`` deploys dev.

        ``branch`` is null when floo cannot tell which branch deploys dev.
    NextStep:
      properties:
        cli:
          anyOf:
            - type: string
            - type: 'null'
          title: Cli
        api:
          anyOf:
            - type: string
            - type: 'null'
          title: Api
        mcp:
          anyOf:
            - type: string
            - type: 'null'
          title: Mcp
        open:
          anyOf:
            - type: string
            - type: 'null'
          title: Open
      type: object
      title: NextStep
      description: >-
        One way forward, spelled for each surface. `open` is a page a person
        must visit.
    DeployResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        app_id:
          type: string
          format: uuid
          title: App Id
        service_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Service Id
        status:
          type: string
          title: Status
        framework:
          anyOf:
            - type: string
            - type: 'null'
          title: Framework
        source_deploy_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Source Deploy Id
        build_logs:
          anyOf:
            - type: string
            - type: 'null'
          title: Build Logs
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        commit_sha:
          anyOf:
            - type: string
            - type: 'null'
          title: Commit Sha
        coalesced_commits:
          items:
            $ref: '#/components/schemas/CoalescedCommitResponse'
          type: array
          title: Coalesced Commits
        github_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Github Ref
        triggered_by:
          type: string
          title: Triggered By
        reconciled_to_head:
          type: boolean
          title: Reconciled To Head
          description: >-
            True when floo redeployed the branch HEAD on its own because dev had
            drifted off it (for example after a CLI deploy of another commit),
            not because of a GitHub push. triggered_by still reads github_push
            for these deploys.
          default: false
        env_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Env Id
        env:
          anyOf:
            - type: string
            - type: 'null'
          title: Env
        target_env:
          anyOf:
            - type: string
            - type: 'null'
          title: Target Env
        target_branch:
          anyOf:
            - type: string
            - type: 'null'
          title: Target Branch
        preview_slug:
          anyOf:
            - type: string
            - type: 'null'
          title: Preview Slug
        source_branch:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Branch
        source_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Hash
        build_args_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Build Args Hash
        skip_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Skip Reason
        skip_migrations:
          type: boolean
          title: Skip Migrations
          default: false
        failure_category:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Category
        failure_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Message
        failure_step:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Step
        failure_root_cause:
          anyOf:
            - $ref: '#/components/schemas/FailureRootCauseResponse'
            - type: 'null'
        failure_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Reason
        failure_stage:
          anyOf:
            - type: string
            - type: 'null'
          title: Failure Stage
        failing_stage:
          anyOf:
            - type: string
            - type: 'null'
          title: Failing Stage
        root_cause_event_excerpt:
          anyOf:
            - type: string
            - type: 'null'
          title: Root Cause Event Excerpt
        migrations:
          anyOf:
            - type: string
            - type: 'null'
          title: Migrations
        steps:
          items:
            $ref: '#/components/schemas/DeployStepResponse'
          type: array
          title: Steps
          default: []
        diagnostics:
          items:
            $ref: '#/components/schemas/DeployDiagnosticResponse'
          type: array
          title: Diagnostics
          default: []
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
        duration_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration Ms
        requested_app_access_mode:
          anyOf:
            - type: string
            - type: 'null'
          title: Requested App Access Mode
        requested_env_access_modes:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Requested Env Access Modes
      type: object
      required:
        - id
        - app_id
        - status
        - framework
        - source_deploy_id
        - build_logs
        - url
        - triggered_by
        - created_at
        - updated_at
      title: DeployResponse
      description: Response for a single deploy.
    ServingDeploy:
      properties:
        deploy_id:
          type: string
          format: uuid
          title: Deploy Id
        commit_sha:
          anyOf:
            - type: string
            - type: 'null'
          title: Commit Sha
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
      type: object
      required:
        - deploy_id
        - commit_sha
        - url
      title: ServingDeploy
      description: The dev deploy serving traffic now.
    GitHubLastPush:
      properties:
        at:
          type: string
          format: date-time
          title: At
        branch:
          type: string
          title: Branch
        commit_sha:
          type: string
          title: Commit Sha
        outcome:
          $ref: '#/components/schemas/PushOutcome'
        needs_action:
          type: boolean
          title: Needs Action
        summary:
          type: string
          title: Summary
        next_step:
          type: string
          title: Next Step
      type: object
      required:
        - at
        - branch
        - commit_sha
        - outcome
        - needs_action
        - summary
        - next_step
      title: GitHubLastPush
      description: The last push webhook for this app and what floo did with it.
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
      additionalProperties: true
      type: object
      required:
        - code
        - message
      title: ErrorDetail
      description: Standard error envelope with operation-specific JSON context.
    AppSourceKind:
      type: string
      enum:
        - github
        - floo
      title: AppSourceKind
      description: Where an app's code lives.
    CoalescedCommitResponse:
      properties:
        requested_commit_sha:
          type: string
          title: Requested Commit Sha
        source_repo_full_name:
          type: string
          title: Source Repo Full Name
        github_ref:
          type: string
          title: Github Ref
        created_at:
          type: string
          format: date-time
          title: Created At
        resolved_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Resolved At
      type: object
      required:
        - requested_commit_sha
        - source_repo_full_name
        - github_ref
        - created_at
      title: CoalescedCommitResponse
      description: A pushed commit whose effective outcome is this deploy.
    FailureRootCauseResponse:
      properties:
        stage:
          anyOf:
            - type: string
            - type: 'null'
          title: Stage
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
        details:
          $ref: '#/components/schemas/JsonObject-Output'
        first_failure_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: First Failure At
        root_cause_event_excerpt:
          anyOf:
            - type: string
            - type: 'null'
          title: Root Cause Event Excerpt
      type: object
      title: FailureRootCauseResponse
      description: Normalized deploy failure summary for operator-facing surfaces.
    DeployStepResponse:
      properties:
        name:
          type: string
          title: Name
        status:
          type: string
          title: Status
        order:
          type: integer
          title: Order
        started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Started At
        finished_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Finished At
        duration_ms:
          anyOf:
            - type: integer
            - type: 'null'
          title: Duration Ms
        error_category:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Category
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Message
        skip_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Skip Reason
      type: object
      required:
        - name
        - status
        - order
      title: DeployStepResponse
      description: Response for a single deploy pipeline step.
    DeployDiagnosticResponse:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        step_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Step Name
        service_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Service Name
        code:
          type: string
          title: Code
        severity:
          type: string
          title: Severity
        source:
          type: string
          title: Source
        title:
          type: string
          title: Title
        message:
          type: string
          title: Message
        fix:
          type: string
          title: Fix
        knowledge_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Knowledge Ref
        evidence_json:
          anyOf:
            - $ref: '#/components/schemas/JsonObject-Output'
            - type: 'null'
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - code
        - severity
        - source
        - title
        - message
        - fix
        - created_at
      title: DeployDiagnosticResponse
      description: Response for one structured deploy diagnostic.
    PushOutcome:
      type: string
      enum:
        - deploying
        - deploy_on_push_off
        - not_default_branch
        - coalesced
        - repo_linked_to_several_apps
      title: PushOutcome
      description: What floo did with the last push webhook for this app.
    JsonObject-Output:
      additionalProperties:
        $ref: '#/components/schemas/JsonValue-Output'
      type: object
    JsonValue-Output:
      anyOf:
        - type: boolean
        - type: integer
        - type: number
        - type: string
        - items:
            $ref: '#/components/schemas/JsonValue-Output'
          type: array
        - additionalProperties:
            $ref: '#/components/schemas/JsonValue-Output'
          type: object
        - type: 'null'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A `floo_` API key.

````

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