> ## 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 Org Overview

> Everything an org admin reviews before letting a team build on floo.



## OpenAPI

````yaml https://api.getfloo.com/openapi.json get /v1/orgs/overview
openapi: 3.1.0
info:
  title: floo API
  version: 0.1.0
servers:
  - url: https://api.getfloo.com
security: []
paths:
  /v1/orgs/overview:
    get:
      tags:
        - orgs
      summary: Get Org Overview
      description: Everything an org admin reviews before letting a team build on floo.
      operationId: orgs_get_org_overview
      parameters:
        - $ref: '#/components/parameters/X-Floo-Org-Id'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgOverviewResponse'
        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:
    OrgOverviewResponse:
      properties:
        members:
          items:
            $ref: '#/components/schemas/OverviewMember'
          type: array
          title: Members
        apps:
          items:
            $ref: '#/components/schemas/OverviewApp'
          type: array
          title: Apps
        keys:
          items:
            $ref: '#/components/schemas/OverviewApiKey'
          type: array
          title: Keys
        domain_people:
          items:
            $ref: '#/components/schemas/OverviewDomainPerson'
          type: array
          title: Domain People
        concerns:
          items:
            $ref: '#/components/schemas/OverviewConcern'
          type: array
          title: Concerns
      type: object
      required:
        - members
        - apps
        - keys
        - domain_people
        - concerns
      title: OrgOverviewResponse
      description: Members, apps, keys and concerns for one organization.
    ErrorResponse:
      properties:
        detail:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - detail
      title: ErrorResponse
      description: Body of every error response except request validation (422).
    OverviewMember:
      properties:
        user_id:
          type: string
          format: uuid
          title: User Id
        email:
          type: string
          title: Email
        role:
          $ref: '#/components/schemas/OrgRole'
        joined_at:
          type: string
          format: date-time
          title: Joined At
      type: object
      required:
        - user_id
        - email
        - role
        - joined_at
      title: OverviewMember
      description: One organization member.
    OverviewApp:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        status:
          $ref: '#/components/schemas/AppStatus'
        envs:
          items:
            $ref: '#/components/schemas/OverviewEnvironment'
          type: array
          title: Envs
        member_count:
          type: integer
          title: Member Count
        open_to_internet:
          type: boolean
          title: Open To Internet
      type: object
      required:
        - id
        - name
        - status
        - envs
        - member_count
        - open_to_internet
      title: OverviewApp
      description: One app with the reach of its dev and prod environments.
    OverviewApiKey:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        owner_email:
          type: string
          title: Owner Email
        scope:
          $ref: '#/components/schemas/KeyScope'
        org_bound:
          type: boolean
          title: Org Bound
        created_at:
          type: string
          format: date-time
          title: Created At
        last_used_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Used At
        unused:
          type: boolean
          title: Unused
      type: object
      required:
        - id
        - name
        - owner_email
        - scope
        - org_bound
        - created_at
        - last_used_at
        - unused
      title: OverviewApiKey
      description: One platform API key that can act in this organization.
    OverviewDomainPerson:
      properties:
        user_id:
          type: string
          format: uuid
          title: User Id
        email:
          type: string
          title: Email
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        signed_up_at:
          type: string
          format: date-time
          title: Signed Up At
        invited:
          type: boolean
          title: Invited
      type: object
      required:
        - user_id
        - email
        - name
        - signed_up_at
        - invited
      title: OverviewDomainPerson
      description: >-
        Someone signed in to floo with an email at the org's verified domain who
        isn't a member.
    OverviewConcern:
      properties:
        code:
          type: string
          enum:
            - APPS_OPEN_TO_INTERNET
            - SINGLE_ADMIN
            - UNUSED_API_KEYS
            - DOMAIN_PEOPLE_OUTSIDE_ORG
          title: Code
        severity:
          type: string
          enum:
            - high
            - medium
          title: Severity
        count:
          type: integer
          title: Count
      type: object
      required:
        - code
        - severity
        - count
      title: OverviewConcern
      description: Something an org admin should look at; the dashboard owns the wording.
    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.
    OrgRole:
      type: string
      enum:
        - admin
        - member
        - viewer
      title: OrgRole
      description: Role of a user within an organization.
    AppStatus:
      type: string
      enum:
        - created
        - deploying
        - live
        - failed
        - stopped
        - deleting
      title: AppStatus
      description: Lifecycle status of an app.
    OverviewEnvironment:
      properties:
        name:
          $ref: '#/components/schemas/EnvironmentName'
        access_mode:
          $ref: '#/components/schemas/AccessMode'
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        ip_restricted:
          type: boolean
          title: Ip Restricted
      type: object
      required:
        - name
        - access_mode
        - url
        - ip_restricted
      title: OverviewEnvironment
      description: Who can reach one deployed environment of an app.
    KeyScope:
      type: string
      enum:
        - read
        - write
        - admin
      title: KeyScope
      description: |-
        Permission scope for an API key.

        Privilege hierarchy: read < write < admin (enforced via scope_level(),
        not native comparison — StrEnum compares lexicographically).
    EnvironmentName:
      type: string
      enum:
        - dev
        - prod
        - preview
      title: EnvironmentName
      description: >-
        Enumerate the persisted development, production, and preview environment
        names.
    AccessMode:
      type: string
      enum:
        - public
        - password
        - accounts
        - sso
      title: AccessMode
      description: Access control mode for an app.
  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.