List org members and their project roles

GET/projects/{project_id}/membersList org members and their project roles

Lists organization members and their per-project roles for an org-owned project. Returns 404 when the project is not org-owned, per-project role management is disabled, or the caller has no access. Callers with VIEWER or EDITOR see members with effective project access. Callers with ADMIN also see unassigned org members.

Parameters

project_idstringpathrequired

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

cursorstringquery

A cursor to use in pagination. A cursor defines your place in the data list. Include `response.pagination.next` in subsequent API calls to fetch next page of the list.

limitintegerquery

The maximum number of members to return in the response

maximum 500 · minimum 1

Responses

objectProjectMembers

paginationobject

To paginate the response, issue an initial request with `limit` value. Then, add the value returned in the response `.pagination.next` attribute into the request under the `cursor` query parameter to the subsequent request to retrieve next page in pagination. The contents on cursor `next` are opaque, clients are not expected to make any assumptions on the format of the data inside the cursor.

Show child attributes

nextstring

Cursor for the next page of results. Pass it as the `cursor` query parameter on the next request. Absent on the last page.

sort_bystring

Field by which the results were sorted, echoing the request's sort_by parameter.

sort_orderstring

Sort order active for this page. Pass back as `sort_order` in the next request to maintain consistent ordering. Valid values are `asc` and `desc`.

project_membersarray of objectrequired

Show child attributes

Show array items

effective_project_permissionstring

The caller's effective permission for a project when per-project permissions are enabled. `VIEWER` grants read access, `EDITOR` adds update access, and `ADMIN` grants full management. Omitted for personal projects, flag-off organizations, and non-user subjects.

one of "VIEWER", "EDITOR", "ADMIN"

emailstring · email

Email address of the user who has been granted access to the project.

maxLength 256 · minLength 1

explicit_project_permissionstring

one of "VIEWER", "EDITOR", "ADMIN"

grant_sourcestring

How a member's project access is granted.

one of "explicit", "org_role_default", "org_admin_override", "unassigned"

member_idstring · uuidrequired

The organization member ID.

namestring

The user's display name.

org_default_project_permissionstring

one of "VIEWER", "EDITOR", "ADMIN"

org_rolestringrequired

Organization-level role used by project member role management.

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

project_rolestring

Per-project role. `viewer` maps to `VIEWER`, `editor` maps to `EDITOR`, and `admin` maps to `ADMIN`.

one of "viewer", "editor", "admin"

user_idstring · uuidrequired

The user ID for the organization member.

Example response

{
  "pagination": {
    "next": "string",
    "sort_by": "string",
    "sort_order": "string"
  },
  "project_members": [
    {
      "effective_project_permission": "ADMIN",
      "email": "user@example.com",
      "explicit_project_permission": "ADMIN",
      "grant_source": "explicit",
      "member_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "org_default_project_permission": "ADMIN",
      "org_role": "admin",
      "project_role": "admin",
      "user_id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

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

project_idrequiredpath parameter

cursorquery parameter

limitquery parameter

curl -X GET 'https://console.neon.tech/api/v2/projects/string/members?cursor=string&limit=0'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/members?cursor=string&limit=0', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/members?cursor=string&limit=0', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://console.neon.tech/api/v2/projects/string/members?cursor=string&limit=0")
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/projects/string/members?cursor=string&limit=0", 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/projects/string/members?cursor=string&limit=0");
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/projects/string/members?cursor=string&limit=0"))
    .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/projects/string/members?cursor=string&limit=0")
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/projects/string/members?cursor=string&limit=0");
using var response = await client.SendAsync(request);

{
  "pagination": {
    "next": "string",
    "sort_by": "string",
    "sort_order": "string"
  },
  "project_members": [
    {
      "effective_project_permission": "ADMIN",
      "email": "user@example.com",
      "explicit_project_permission": "ADMIN",
      "grant_source": "explicit",
      "member_id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "org_default_project_permission": "ADMIN",
      "org_role": "admin",
      "project_role": "admin",
      "user_id": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

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