Retrieve organization details

Retrieves details for the specified organization, including its name, plan, and configuration.

GET /organizations/{org_id}

Retrieves details for the specified organization, including its name, plan, and configuration.

REST API - curl

curl "https://console.neon.tech/api/v2/organizations/$ORG_ID" \
  -H "Authorization: Bearer $NEON_API_KEY"

Every field below is optional. An empty body works too.

Also available in

TypeScript

import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.getOrganization({
  client: neon.client,
  path: {
    org_id: process.env.ORG_ID
  }
});

Tool: list_organizations

List all organizations the current user belongs to. Supports optional search parameter to filter by name or ID.

search (string, optional) Search organizations by name or ID. You can specify partial name or ID values to filter results.

Parameters

Organization

org_id

string

The Neon organization ID

Response

200

Returned information about the organization

Depth

"id": (string),req

"name": (string),req

"handle": (string),req

"plan": (string),req

"created_at": (string),reqdate-time

"managed_by": (string),req

"updated_at": (string),reqdate-time

"allow_hipaa_projects": (boolean),

"require_mfa": (boolean),

Errors

default

General error

This endpoint can return the standard Neon API error response.

Response fields

message Required. Human-readable error message.
code Required. Machine-readable error code.
request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.