> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-home-button.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter detalhes da organization

> Retorna os detalhes de uma organização específica. Para obter esses detalhes, a chave de autenticação deve pertencer à organização.



## OpenAPI

````yaml /pt-BR/products/cloud/api-reference/cloud-openapi.json get /v1/organizations/{organizationId}
openapi: 3.0.1
info:
  contact:
    email: support@clickhouse.com
    name: ClickHouse Support
    url: >-
      https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-299828
  title: OpenAPI spec for ClickHouse Cloud
  version: '1.0'
servers:
  - url: https://api.clickhouse.cloud
security:
  - basicAuth: []
tags:
  - name: Organization
  - name: User management
  - name: Billing
  - name: Service
  - name: Backup
  - name: OpenAPI
  - name: Prometheus
  - name: ClickPipes
paths:
  /v1/organizations/{organizationId}:
    get:
      tags:
        - Organization
      summary: Obter detalhes da organization
      description: >-
        Retorna os detalhes de uma organização específica. Para obter esses
        detalhes, a chave de autenticação deve pertencer à organização.
      parameters:
        - description: ID da organização solicitada.
          in: path
          name: organizationId
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  requestId:
                    description: ID único atribuído a cada solicitação. UUIDv4
                    format: uuid
                    type: string
                  result:
                    $ref: '#/components/schemas/Organization'
                  status:
                    description: Código de status HTTP.
                    example: 200
                    type: number
                type: object
          description: Resposta bem-sucedida
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    description: Descrição detalhada do erro.
                    type: string
                  status:
                    description: Código de status HTTP.
                    example: 400
                    type: number
                type: object
          description: >-
            O servidor não pode ou não quer processar a solicitação devido a
            algo considerado um erro do cliente.
components:
  schemas:
    Organization:
      properties:
        byocConfig:
          description: Configuração BYOC da organização
          items:
            $ref: '#/components/schemas/ByocConfig'
          type: array
        createdAt:
          description: Timestamp em que a organização foi criada. ISO-8601.
          format: date-time
          type: string
        id:
          description: Organization ID único.
          format: uuid
          type: string
        name:
          description: Nome da organização.
          type: string
        privateEndpoints:
          description: Lista de endpoints privados da organização
          items:
            $ref: '#/components/schemas/OrganizationPrivateEndpoint'
          type: array
    ByocConfig:
      properties:
        accountName:
          description: Nome da conta
          type: string
        cloudProvider:
          description: provedor de Cloud da região
          enum:
            - gcp
            - aws
            - azure
          type: string
        id:
          description: Identificador único da configuração BYOC
          type: string
        regionId:
          description: >-
            Região para a qual o BYOC foi configurado e onde é possível criar
            serviços
          enum:
            - ap-northeast-1
            - ap-south-1
            - ap-southeast-1
            - ap-southeast-2
            - eu-central-1
            - eu-west-1
            - eu-west-2
            - me-central-1
            - us-east-1
            - us-east-2
            - us-west-2
            - us-east1
            - us-central1
            - europe-west4
            - asia-southeast1
            - eastus
            - eastus2
            - westus3
            - germanywestcentral
          type: string
        state:
          description: Estado da infraestrutura
          enum:
            - infra-ready
            - infra-provisioning
            - infra-terminated
          type: string
    OrganizationPrivateEndpoint:
      properties:
        cloudProvider:
          description: provedor de Cloud em que o endpoint privado está localizado
          enum:
            - gcp
            - aws
            - azure
          type: string
        description:
          description: Descrição do endpoint privado
          type: string
        id:
          description: Identificador do endpoint privado
          type: string
        region:
          description: Região em que o endpoint privado está localizado
          enum:
            - ap-northeast-1
            - ap-south-1
            - ap-southeast-1
            - ap-southeast-2
            - eu-central-1
            - eu-west-1
            - eu-west-2
            - me-central-1
            - us-east-1
            - us-east-2
            - us-west-2
            - us-east1
            - us-central1
            - europe-west4
            - asia-southeast1
            - eastus
            - eastus2
            - westus3
            - germanywestcentral
          type: string
  securitySchemes:
    basicAuth:
      description: >-
        Use o ID da chave e o segredo da chave obtidos no ClickHouse Cloud
        console: https://clickhouse.com/docs/cloud/manage/openapi
      scheme: basic
      type: http

````