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

# Obter a organização

> Obter detalhes de uma organização específica

<Info>
  Ação primária do IAM: **`workspace:GetOrganization`**. Membros humanos da organização podem ler sua organização sem essa ação. Contas de serviço e funções assumidas exigem essa permissão da organização. Consulte [permissões de Workspace](/pt/workspace/permissions) para obter exemplos de políticas.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/workspace.yaml get /v1/organizations/{organization_id}
openapi: 3.0.3
info:
  title: Basaltic Workspace API
  version: 1.0.0
  description: >
    Gerenciamento de organização: organizações, contas, usuários humanos, grupos
    somente de usuários e políticas de organização. As identidades do IAM de
    conta podem receber políticas de organização explicitamente delegadas por
    meio dessa API. A autenticação pessoal permanece no endpoint do IAM.


    Os recursos da organização são globais e são resolvidos na organização
    autenticada.CRNs canônicos são crn:workspace:::<type>/<name-or-uuid>As
    políticas da organização são separadas das políticas de conta; as políticas
    de sistema compartilhadas usam crn:workspace:::system-policy/<name>.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://workspace.basaltic.sh
    description: Endpoint global da API
security:
  - BearerAuth: []
paths:
  /v1/organizations/{organization_id}:
    get:
      tags:
        - Organizations
      summary: Obter a organização
      description: Obter detalhes de uma organização específica
      operationId: getOrganization
      parameters:
        - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          description: Detalhes da organização
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  parameters:
    OrganizationId:
      name: organization_id
      in: path
      description: ID da organização
      required: true
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    OrganizationResponse:
      type: object
      properties:
        organization:
          $ref: '#/components/schemas/Organization'
    Organization:
      type: object
      properties:
        language:
          type: string
          enum:
            - en
            - pt-BR
            - es
          default: en
          description: >-
            Idioma para e-mails operacionais e de faturamento da organização,
            independente da preferência de console de cada usuário.
        time_zone:
          type: string
          default: UTC
          example: America/Sao_Paulo
          description: >-
            Fuso horário IANA para formatação de e-mails da organização. Não
            altera períodos de faturamento ou agendamentos de recursos.
        id:
          type: string
          format: uuid
          readOnly: true
          example: 550e8400-e29b-41d4-a716-446655440000
        name:
          type: string
          example: Acme Corporation
        description:
          type: string
          example: Cloud infrastructure for Acme Corporation
        owner_id:
          type: string
          format: uuid
          readOnly: true
          description: ID do proprietário da organização
          example: 550e8400-e29b-41d4-a716-446655440000
        status:
          type: string
          readOnly: true
          enum:
            - pending
            - active
            - suspended
            - terminated
          description: >
            Estado do ciclo de vida. Uma organização recém-criada está `pending`
            até que seu proprietário tenha verificado um número de telefone e
            anexado um método de pagamento; até então, cada API de recursos a
            recusa com `ORGANIZATION_ONBOARDING_REQUIRED`. `suspended` é uma
            retenção administrativa ou de cobrança, e `terminated` é
            irreversível.
          example: active
        suspension_reason:
          type: string
          readOnly: true
          enum:
            - billing
            - manual
          description: >
            Por que a organização está suspensa; ausente a menos que seja. Os
            dois são os mesmos `status` mas não a mesma situação — um `billing`
            hold é um que o cliente pode limpar liquidando sua conta, e a
            plataforma ainda concede contexto de organização para isso, para que
            eles possam chegar ao faturamento para fazê-lo. `manual` hold é uma
            decisão do operador e não concede nada.
          example: billing
        created_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-15T09:30:00Z'
        updated_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-16T14:20:00Z'
        crn:
          type: string
          readOnly: true
          description: Identidade de recurso do Canonical Workspace.
          example: crn:workspace:::organization/current
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: Página não encontrada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Erro interno do servidor
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

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