Neon API (unofficial showcase)
GET/organizations/{org_id}

Retrieve organization details

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

1 parameter
org_idstringrequired
The Neon organization ID

2 status codes
200Returned information about the organization
idstringrequired
The Neon organization ID. Use as the `org_id` path parameter in other endpoints.
namestringrequired
Human-readable display name of the organization.
handlestringrequired
URL-safe identifier for the organization, used in API paths. Distinct from the display name.
planstringrequired
Billing plan for the organization, for example `free`, `launch`, or `scale`.
created_atstringrequired
A timestamp indicting when the organization was created
managed_bystringrequired
Organizations created via the Console or the API are managed by `console`. Organizations created by other methods can't be deleted via the Console or the API.
updated_atstringrequired
A timestamp indicating when the organization was updated
allow_hipaa_projectsbooleanoptional
If true, allow account to mark projects as HIPAA
require_mfabooleanoptional
If true, all members must have MFA enabled to access this organization
defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
request_idstringoptional
Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

Any other status is an error: General Error.

The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received.

  • If no response is returned from the API, a network error or timeout likely occurred.
  • In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.

The following HTTP methods are considered non-idempotent: POST, PATCH, DELETE, and PUT. Retrying these methods is generally not safe. The following methods are considered idempotent: GET, HEAD, and OPTIONS. Retrying these methods is safe in the event of a network error or timeout.

Any request that returns a 503 Service Unavailable response is always safe to retry.

Any request that returns a 423 Locked response is safe to retry. 423 Locked indicates that the resource is temporarily locked, for example, due to another operation in progress.