OBTER /api/v1/organizations
Autenticação do portador

Retorna apenas organizações em que o chamador é membro. Quando a concessão do Atlas é inutilizável, as últimas organizações refletidas ainda são retornadas como somente leitura com atlas_reauth_required=true.

Respostas

  • 406

    Versão de API não permitida ou malformada, uma operação indisponível no contrato publicado selecionado ou uma representação inaceitável (incluindo parâmetros de tipo de mídia não suportados ou SSE excluído). Falhas existentes de autenticação, autorização e limite de taxa têm precedência.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes de validação opcionais definidos pelo esquema de erro padrão; Os erros de negociação da API não emitem este campo.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Campos com falhas de validação.

        Ocultar atributos de campos Mostrar atributos dos campos objeto

        Um campo e sua falha de validação.

        • Descrição string Obrigatório

          Falha na validação legível por humanos.

        • Campo string Obrigatório

          Nome ou caminho do campo de solicitação inválido .

    • detalhe string Obrigatório

      Detalhes de erro legíveis por humanos.

    • Erro inteiro Obrigatório

      HTTP status code.

    • Código de erro string Obrigatório

      Código de erro legível por máquina.

    • Parâmetros array[string]

      Solicitar nomes de parâmetros associados ao erro; omitido quando nenhum se aplica.

    • Razão string Obrigatório

      Frase de razão do status HTTP.
  • 200

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • atlas_reauth_required booleano

      AtlasReauthRequired é definido nessa resposta 200 quando a concessão do Atlas é inutilizável, mas o gateway ainda retorna as últimas organizações refletidas como somente leitura. Os clientes devem iniciar a recuperação a partir deste campo; a lista de organização não retorna 401 PLATFORM_OAUTH_*.

    • limit inteiro

      Limit e Offset refletem a paginação aplicada. Definido somente pela listagem de administração da plataforma paginada; omitido nos endpoints da organização voltados para os membros.

    • offset inteiro
    • organizações array[objeto]
      Ocultar atributos das organizações Mostrar atributos das organizações objeto
      • admins array[objeto]

        Admins lista os ORG_ADMINs da organização. Preenchido somente pela listagem de administrador da plataforma; omitido nos endpoints da organização voltados para os membros.

        Ocultar atributos de administradores Mostrar atributos dos administradores objeto
        • Email string
        • name string
      • atlas objeto
        Ocultar atributos do atlas Mostrar atributos do atlas objeto
        • ambiente string Obrigatório
        • id string Obrigatório
      • created_at string
      • Descrição string
      • id string
      • name string
      • Fonte string

        Os valores são atlas ou agent_engine.

      • updated_at string
    • Total inteiro
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • atlas_reauth_required booleano

      AtlasReauthRequired é definido nessa resposta 200 quando a concessão do Atlas é inutilizável, mas o gateway ainda retorna as últimas organizações refletidas como somente leitura. Os clientes devem iniciar a recuperação a partir deste campo; a lista de organização não retorna 401 PLATFORM_OAUTH_*.

    • limit inteiro

      Limit e Offset refletem a paginação aplicada. Definido somente pela listagem de administração da plataforma paginada; omitido nos endpoints da organização voltados para os membros.

    • offset inteiro
    • organizações array[objeto]
      Ocultar atributos das organizações Mostrar atributos das organizações objeto
      • admins array[objeto]

        Admins lista os ORG_ADMINs da organização. Preenchido somente pela listagem de administrador da plataforma; omitido nos endpoints da organização voltados para os membros.

        Ocultar atributos de administradores Mostrar atributos dos administradores objeto
        • Email string
        • name string
      • atlas objeto
        Ocultar atributos do atlas Mostrar atributos do atlas objeto
        • ambiente string Obrigatório
        • id string Obrigatório
      • created_at string
      • Descrição string
      • id string
      • name string
      • Fonte string

        Os valores são atlas ou agent_engine.

      • updated_at string
    • Total inteiro
  • 500

    Erro interno do servidor

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • código string
    • Erro string
    • Sucesso booleano
GET /api/v1/organizations 
curl \
 --request GET 'https://agentengine.mongodb.com/api/v1/organizations' \
 --header "Authorization: $API_KEY"
Exemplos de resposta (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "This operation supports text/event-stream, which the Accept header excludes. Remove unsupported media-type parameters or accept this type with a positive q value.",
  "error": 406,
  "errorCode": "UNACCEPTABLE_MEDIA_TYPE",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
{
  "detail": "The requested API version is not supported. Supported versions: 2026-09-20-preview.",
  "error": 406,
  "errorCode": "UNSUPPORTED_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (406) 
{
  "detail": "This operation is not available in API version 2026-09-20-preview.",
  "error": 406,
  "errorCode": "OPERATION_NOT_IN_API_VERSION",
  "parameters": [
    "Accept"
  ],
  "reason": "Not Acceptable"
}
Exemplos de resposta (200) 
{
  "atlas_reauth_required": true,
  "limit": 42,
  "offset": 42,
  "organizations": [
    {
      "admins": [
        {
          "email": "string",
          "name": "string"
        }
      ],
      "atlas": {
        "environment": "string",
        "id": "string"
      },
      "created_at": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "source": "atlas",
      "updated_at": "string"
    }
  ],
  "total": 42
}
Exemplos de resposta (200) 
{
  "atlas_reauth_required": true,
  "limit": 42,
  "offset": 42,
  "organizations": [
    {
      "admins": [
        {
          "email": "string",
          "name": "string"
        }
      ],
      "atlas": {
        "environment": "string",
        "id": "string"
      },
      "created_at": "string",
      "description": "string",
      "id": "string",
      "name": "string",
      "source": "atlas",
      "updated_at": "string"
    }
  ],
  "total": 42
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}
Exemplos de resposta (500) 
{
  "code": "string",
  "error": "string",
  "success": true
}