List organization invitations | Neon Postgres Docs

GET/organizations/{org_id}/invitationsList organization invitations

Retrieves pending and accepted invitations for the specified organization.

Parameters

org_idstringpathrequired

The Neon organization ID

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

Responses

objectOrganizationInvitationsResponse

invitationsarray of objectrequired

List of pending invitations for the organization.

Show child attributes

Show array items

emailstring · emailrequired

Email of the invited user

maxLength 256 · minLength 1

idstring · uuidrequired

The invitation ID.

invited_atstring · date-timerequired

Timestamp when the invitation was created

invited_bystring · uuidrequired

UUID for the user_id who extended the invitation

org_idstringrequired

Organization id as it is stored in Neon

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

rolestringrequired

Organization member's role. `admin`: full administrative access. `editor` (and its legacy alias `member`): standard access governed by project permissions. `viewer` and `collaborator`: additional scoped project roles. Some values may not be available for all organizations.

one of "admin", "member", "editor", "viewer", "collaborator"

Example response

{
  "invitations": [
    {
      "email": "invited1@email.com",
      "id": "db8faf32-b07f-4b0f-94c8-5c288909f5d3",
      "invited_at": "2024-02-23T17:42:25Z",
      "invited_by": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "org_id": "my-organization-morning-bread-81040908",
      "role": "admin"
    },
    {
      "email": "invited2@email.com",
      "id": "c52f0d22-ebd9-4708-ae44-2872cae49a83",
      "invited_at": "2024-02-23T12:42:25Z",
      "invited_by": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "org_id": "my-organization-morning-bread-81040908",
      "role": "member"
    }
  ]
}

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/invitations'

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

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

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/organizations/string/invitations")
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/invitations", 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/invitations");
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/invitations"))
    .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/invitations")
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/invitations");
using var response = await client.SendAsync(request);

{
  "invitations": [
    {
      "email": "invited1@email.com",
      "id": "db8faf32-b07f-4b0f-94c8-5c288909f5d3",
      "invited_at": "2024-02-23T17:42:25Z",
      "invited_by": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "org_id": "my-organization-morning-bread-81040908",
      "role": "admin"
    },
    {
      "email": "invited2@email.com",
      "id": "c52f0d22-ebd9-4708-ae44-2872cae49a83",
      "invited_at": "2024-02-23T12:42:25Z",
      "invited_by": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "org_id": "my-organization-morning-bread-81040908",
      "role": "member"
    }
  ]
}

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