Sign in
Organizations

Retrieve organization details

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

get/organizations/{org_id}

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/organizations/{org_id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Response

Returned information about the organization

idstring required

The Neon organization ID. Use as the org_id path parameter in other endpoints.

namestring required

Human-readable display name of the organization.

handlestring required

URL-safe identifier for the organization, used in API paths. Distinct from the display name.

planstring required

Billing plan for the organization, for example free, launch, or scale.

created_atstring date-time required

A timestamp indicting when the organization was created

managed_bystring required

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_atstring date-time required

A timestamp indicating when the organization was updated

allow_hipaa_projectsboolean

If true, allow account to mark projects as HIPAA

require_mfaboolean

If true, all members must have MFA enabled to access this organization

Changes

No recorded changes to this operation across all 15 revisions of this API.