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

# List organizations

> The wallets this account can bill: your personal account first, then every organization you belong to, each with its id and name. Either spelling works wherever an org is passed (`org`, `X-Boat-Org`, `teamId`). `active` marks the wallet new sandboxes bill when a request names none; change it with `PATCH /orgs/active`.



## OpenAPI

````yaml openapi/boat-v1.yaml GET /orgs
openapi: 3.1.0
info:
  title: Boat Public API v1
  version: 1.0.0
  description: >
    Public JSON API for creating, operating, prompting, observing, and exposing
    sandboxes from backend services, CI jobs, hosted workers, and Boat
    automation products.


    The v1 reference intentionally documents the developer integration surface
    only. Dashboard billing actions are not part of v1.
servers:
  - url: https://boat.dev/api/v1
security:
  - BoatBearerAuth: []
tags:
  - name: Boat
    description: >-
      Unified Boat account, setup, lifecycle, prompting, event history, desktop
      access, and SSH operations.
paths:
  /orgs:
    get:
      tags:
        - Boat
      summary: List organizations
      description: >-
        The wallets this account can bill: your personal account first, then
        every organization you belong to, each with its id and name. Either
        spelling works wherever an org is passed (`org`, `X-Boat-Org`,
        `teamId`). `active` marks the wallet new sandboxes bill when a request
        names none; change it with `PATCH /orgs/active`.
      operationId: listOrganizations
      responses:
        '200':
          description: Personal account and organizations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgListResponse'
              examples:
                orgs:
                  value:
                    ok: true
                    type: org.list
                    activeWalletChosen: true
                    orgs:
                      - id: 4f1c2e0a-7b3d-4a6e-9c8b-2d5e1f0a3b7c
                        name: Personal
                        type: personal
                        role: owner
                        memberCount: 1
                        active: false
                      - id: team_583fd89e-6d29-4007-b48d-52477656cb0f
                        name: acme
                        type: org
                        role: owner
                        memberCount: 3
                        subscriptionStatus: active
                        active: true
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    OrgListResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessBase'
        - type: object
          required:
            - orgs
            - activeWalletChosen
          properties:
            type:
              type: string
              const: org.list
            activeWalletChosen:
              type: boolean
              description: >-
                Whether this account ever set its active wallet. `false` means
                personal by default, never a choice.
            orgs:
              type: array
              items:
                $ref: '#/components/schemas/Org'
    SuccessBase:
      type: object
      required:
        - ok
        - type
      properties:
        ok:
          type: boolean
          examples:
            - true
        type:
          type: string
          description: Stable success envelope discriminator added by v1.
    Org:
      type: object
      required:
        - id
        - name
        - type
        - role
        - memberCount
        - active
      properties:
        id:
          type: string
          description: Your account id for the personal row, `team_…` for an organization.
        name:
          type: string
          description: Accepted wherever an org is passed, like the id.
        type:
          type: string
          enum:
            - personal
            - org
        role:
          type: string
          enum:
            - owner
            - member
        memberCount:
          type: integer
        subscriptionStatus:
          type: string
          description: >-
            Stripe status of the organization's plan; absent on the personal
            row.
        active:
          type: boolean
          description: The wallet new sandboxes bill when a request names none.
    ErrorEnvelope:
      type: object
      required:
        - ok
        - type
        - status
        - code
        - message
        - error
        - requestId
      properties:
        ok:
          type: boolean
          examples:
            - false
        type:
          type: string
          examples:
            - sandbox.error
        status:
          type: integer
          examples:
            - 409
        code:
          type: string
          examples:
            - provider_not_configured
        message:
          type: string
          examples:
            - Prompting is locked until Codex is configured on the Agents page.
        requestId:
          type: string
          examples:
            - req_01HX...
        error:
          type: object
          required:
            - code
            - message
            - status
          properties:
            code:
              type: string
            message:
              type: string
            status:
              type: integer
            details:
              type: object
              additionalProperties: true
  responses:
    Unauthorized:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            unauthorized:
              value:
                ok: false
                type: sandbox.error
                status: 401
                code: unauthorized
                message: Unauthorized
                error:
                  code: unauthorized
                  message: Unauthorized
                  status: 401
                requestId: req_01HX...
  securitySchemes:
    BoatBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: sandbox_api_key
      description: >-
        Boat bearer token in the form `boat_...`. Service API keys authenticate
        sandbox operations.

````

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