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

# List organizations the caller can see (or one by name)



## OpenAPI

````yaml https://us.console.entire.io/api/v1/openapi.json get /orgs
openapi: 3.1.0
info:
  description: >-
    Entire control plane: identity, orgs, projects, repos, mirrors, service
    accounts.
  title: Entire Core API
  version: 1.0.0
servers:
  - url: https://us.console.entire.io/api/v1
security: []
tags:
  - name: identity
    x-group: Account
  - name: orgs
    x-group: Organizations
  - name: projects
    x-group: Projects
  - name: repos
    x-group: Repositories
  - name: clusters
    x-group: Clusters
paths:
  /orgs:
    get:
      tags:
        - orgs
      summary: List organizations the caller can see (or one by name)
      operationId: listOrgs
      parameters:
        - description: Maximum entries to return; server may cap further.
          explode: false
          in: query
          name: pageSize
          schema:
            description: Maximum entries to return; server may cap further.
            format: int32
            maximum: 500
            minimum: 0
            type: integer
        - description: Opaque cursor from a previous response's nextPageToken.
          explode: false
          in: query
          name: pageToken
          schema:
            description: Opaque cursor from a previous response's nextPageToken.
            type: string
        - description: >-
            Deprecated: exact org name among the caller's own orgs,
            case-insensitive. List orgs and match client-side instead.
          explode: false
          in: query
          name: name
          schema:
            deprecated: true
            description: >-
              Deprecated: exact org name among the caller's own orgs,
              case-insensitive. List orgs and match client-side instead.
            type: string
        - in: header
          name: If-None-Match
          schema:
            type: string
        - description: >-
            Optional: opaque commit token from an org create or delete, to read
            at a snapshot that contains that write. Applies to both the name
            lookup and the page.
          explode: false
          in: query
          name: commitToken
          schema:
            description: >-
              Optional: opaque commit token from an org create or delete, to
              read at a snapshot that contains that write. Applies to both the
              name lookup and the page.
            pattern: ^$|^[A-Za-z0-9_-]{20,512}$
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrgsOutputBody'
          description: OK
          headers:
            Cache-Control:
              schema:
                type: string
            ETag:
              schema:
                type: string
            Vary:
              schema:
                type: string
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Not Found
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Internal Server Error
      security:
        - oauth2: []
        - oidc: []
        - bearerAuth: []
        - sessionAuth: []
components:
  schemas:
    ListOrgsOutputBody:
      additionalProperties: true
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - /api/v1/schemas/ListOrgsOutputBody.json
          format: uri
          readOnly: true
          type: string
        nextPageToken:
          description: Pass back to fetch the next page; empty when no more entries.
          type: string
        org:
          $ref: '#/components/schemas/Org'
        orgs:
          items:
            $ref: '#/components/schemas/Org'
          type: array
      type: object
    ErrorModel:
      additionalProperties: true
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - /api/v1/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    Org:
      additionalProperties: true
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - /api/v1/schemas/Org.json
          format: uri
          readOnly: true
          type: string
        capabilities:
          $ref: '#/components/schemas/OrgCapabilities'
        createdAt:
          format: date-time
          type: string
        id:
          type: string
        name:
          type: string
        provider:
          description: >-
            Set when the org is linked to an external source, e.g. a GitHub
            organization.
          enum:
            - github
          type: string
        region:
          type: string
        workosOrganizationId:
          type: string
      required:
        - id
        - name
        - region
        - createdAt
        - capabilities
      type: object
    ErrorDetail:
      additionalProperties: true
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    OrgCapabilities:
      additionalProperties: true
      properties:
        canChangeOwners:
          description: >-
            Whether this surface permits the caller to change organization
            owners. Individual mutations still enforce all guards.
          type: boolean
        canCreateProject:
          type: boolean
        canDelete:
          type: boolean
        canListProjects:
          description: Whether the caller may list this org's projects.
          type: boolean
        canManageBilling:
          description: Whether the caller may view and manage this org's billing.
          type: boolean
        canManageMembers:
          type: boolean
        canView:
          description: Whether the caller may see this org's projects and members.
          type: boolean
      required:
        - canCreateProject
        - canManageMembers
        - canDelete
        - canView
        - canListProjects
        - canManageBilling
        - canChangeOwners
      type: object
  securitySchemes:
    oauth2:
      description: >-
        Authorization code flow with PKCE-S256. RFC 8628 device flow is also
        supported.
      flows:
        authorizationCode:
          authorizationUrl: /authorize
          scopes:
            offline_access: Request a refresh token.
            openid: Authenticate using OpenID Connect.
          tokenUrl: /oauth/token
      type: oauth2
    oidc:
      description: OpenID Connect discovery for browser and RFC 8628 device authentication.
      openIdConnectUrl: /.well-known/openid-configuration
      type: openIdConnect
    bearerAuth:
      bearerFormat: JWT
      description: Bearer access token.
      scheme: bearer
      type: http
    sessionAuth:
      description: Console session cookie issued by the browser login flow.
      in: cookie
      name: entire_session
      type: apiKey

````