Retrieve organization details | Neon Postgres Docs

GET/organizations/{org_id}Retrieve organization details

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

Parameters

org_idstringpathrequired

The Neon organization ID

pattern ^[a-z0-9-]{1,60}$

Responses

objectOrganization

allow_hipaa_projectsboolean

If true, allow account to mark projects as HIPAA

created_atstring · date-timerequired

A timestamp indicting when the organization was created

handlestringrequired

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

idstringrequired

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

pattern ^[a-z0-9-]{1,60}$

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.

namestringrequired

Human-readable display name of the organization.

planstringrequired

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

require_mfaboolean

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

updated_atstring · date-timerequired

A timestamp indicating when the organization was updated

Example response

{
  "created_at": "2024-02-23T17:42:25Z",
  "handle": "my-organization-my-organization-morning-bread-81040908",
  "id": "my-organization-morning-bread-81040908",
  "managed_by": "console",
  "name": "my-organization",
  "plan": "scale",
  "require_mfa": false,
  "updated_at": "2024-02-26T20:41:25Z"
}

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. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

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.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

org_idrequiredpath parameter

curl -X GET 'https://console.neon.tech/api/v2/organizations/string'

const response = await fetch('https://console.neon.tech/api/v2/organizations/string', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/organizations/string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/organizations/string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://console.neon.tech/api/v2/organizations/string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/organizations/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/organizations/string"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/organizations/string")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://console.neon.tech/api/v2/organizations/string");
using var response = await client.SendAsync(request);

{
  "created_at": "2024-02-23T17:42:25Z",
  "handle": "my-organization-my-organization-morning-bread-81040908",
  "id": "my-organization-morning-bread-81040908",
  "managed_by": "console",
  "name": "my-organization",
  "plan": "scale",
  "require_mfa": false,
  "updated_at": "2024-02-26T20:41:25Z"
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}