List shared projects | Neon Postgres Docs

GET/projects/sharedList shared projects

Retrieves a list of projects shared with your Neon account. For more information, see Manage projects.

Parameters

cursorstringquery

Specify the cursor value from the previous response to get the next batch of projects.

limitintegerquery

Specify a value from 1 to 400 to limit number of projects in the response.

default 10 · maximum 400 · minimum 1

searchstringquery

Search query by name or id.

timeoutintegerquery

Specify an explicit timeout in milliseconds to limit response delay. After timing out, the incomplete list of project data fetched so far will be returned. Projects still being fetched when the timeout occurred are listed in the "unavailable" attribute of the response. If not specified, an implicit implementation defined timeout is chosen with the same behaviour as above

maximum 30000 · minimum 100

Responses

value

allOf · 2 options

Option 1objectProjectsResponse

projectsarray of objectrequired

List of projects accessible to the caller. Projects that exist but could not be retrieved are identified in `unavailable_project_ids`.

Show child attributes

Show array items

Essential data about the project. Full data is available at `GET /projects/{project_id}`.

active_timeinteger · int64required

Control plane observed endpoints of this project being active this amount of wall-clock time.

minimum 0

branch_logical_size_limitinteger · int64required

The logical size limit for a branch. The value is in MiB.

branch_logical_size_limit_bytesinteger · int64required

The logical size limit for a branch. The value is in B.

compute_last_active_atstring · date-time

The most recent time when any endpoint of this project was active. Omitted when observed no activity for endpoints of this project.

cpu_used_secinteger · int64required

Deprecated. Use `compute_time_seconds` from `GET /projects/{project_id}` instead.

created_atstring · date-timerequired

A timestamp indicating when the project was created

creation_sourcestringrequired

The project creation source

default_endpoint_settingsobject

A collection of settings for a Neon endpoint

Show child attributes

autoscaling_limit_max_cunumber

minimum 0.25

autoscaling_limit_min_cunumber

minimum 0.25

pg_settingsobject

A raw representation of Postgres settings

pgbouncer_settingsobject

Deprecated. A raw representation of PgBouncer settings. Removal scheduled for June 20, 2026.

suspend_timeout_secondsinteger · int64

Duration of inactivity in seconds after which the compute endpoint is automatically suspended. The value `0` means use the default value. The value `-1` means never suspend. The default value is `300` seconds (5 minutes). The minimum value is `60` seconds (1 minute). The maximum value is `604800` seconds (1 week). For more information, see [Scale to zero configuration](https://neon.com/docs/manage/endpoints#scale-to-zero-configuration).

maximum 604800 · minimum -1

deleted_atstring · date-time

A timestamp indicating when the project was deleted

effective_project_permissionvalue

Show child attributes

anyOf · 2 options

Option 1string

allOf · 1 option

Option 1stringProjectPermissionLevel

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"

Option 2nullnullable

hipaa_enabled_atstring · date-time

A timestamp indicating when HIPAA was enabled for this project

history_retention_secondsinteger · int32

The number of seconds to retain the shared history for all branches in this project.

idstringrequired

The Neon project ID. Use as the `project_id` path parameter in other endpoints.

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

maintenance_starts_atstring · date-time

A timestamp indicating when project maintenance begins. If set, the project is placed into maintenance mode at this time.

namestringrequired

The project name

org_idstring

ID of the organization that owns the project. Project permissions are granted to organization members as configured by the organization's admins, independent of which member created the project.

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

org_namestring

Name of the organization that owns the project.

owner_idstringrequired

ID of the organization that owns the project.

pg_versionintegerrequired

The major Postgres version number. Supported versions are `14`, `15`, `16`, `17`, and `18`. `19` is rolling out and is accepted only in regions where it is enabled; requesting it elsewhere returns an error.

default 18 · maximum 19 · minimum 14

platform_idstringrequired

The cloud platform identifier. Currently, only AWS is supported, for which the identifier is `aws`.

provisionerstringrequired

proxy_hoststringrequired

The proxy host for the project. This value combines the `region_id`, the `platform_id`, and the Neon domain (`neon.tech`).

quota_reset_atstring · date-time

Deprecated. Use `consumption_period_end` from `GET /projects/{project_id}` instead. A timestamp indicating when the project quota resets.

recoverable_untilstring · date-time

A timestamp indicating the project will be recoverable until this date and time.

region_idstringrequired

Cloud region where the project's Postgres compute and storage reside (for example, `aws-us-east-2`). Valid values are returned by `GET /regions`.

settingsobject

Show child attributes

allowed_ipsobject

A list of IP addresses that are allowed to connect to the compute endpoint. If the list is empty or not set, all IP addresses are allowed. If protected_branches_only is true, the list will be applied only to protected branches.

Show child attributes

ipsarray of string

A list of IP addresses that are allowed to connect to the endpoint.

Show child attributes

protected_branches_onlyboolean

If true, the list will be applied only to protected branches.

audit_log_levelstring

one of "base", "extended", "full"

block_public_connectionsboolean

When set, connections from the public internet are disallowed. This supersedes the AllowedIPs list. This parameter is under active development and its semantics may change in the future.

block_vpc_connectionsboolean

When set, connections using VPC endpoints are disallowed. This parameter is under active development and its semantics may change in the future.

enable_logical_replicationboolean

Sets wal_level=logical for all compute endpoints in this project. All active endpoints will be suspended. Once enabled, logical replication cannot be disabled.

hipaaboolean

Enables HIPAA compliance mode for the project, including audit logging.

maintenance_windowobject

A maintenance window is a time period during which Neon may perform maintenance on the project's infrastructure. During this time, the project's compute endpoints may be unavailable and existing connections can be interrupted.

Show child attributes

end_timestringrequired

End time of the maintenance window, in the format of "HH:MM". Uses UTC.

start_timestringrequired

Start time of the maintenance window, in the format of "HH:MM". Uses UTC.

weekdaysarray of integerrequired

A list of weekdays when the maintenance window is active. Encoded as ints, where 1 - Monday, and 7 - Sunday.

Show child attributes

preload_librariesobject

The shared libraries to preload into the project's compute instances.

Show child attributes

enabled_librariesarray of string

Names of shared preload libraries to enable for the project.

Show child attributes

use_defaultsboolean

When true, the project's preload libraries include the platform default set in addition to any libraries listed in `enabled_libraries`.

quotaobject

Per-project consumption quotas. If a quota is exceeded, all active computes are automatically suspended and cannot be started via API calls or incoming connections. The exception is `logical_size_bytes`, which is enforced per branch. If a branch exceeds its `logical_size_bytes` quota, computes can still be started, but write operations will fail—allowing data to be deleted to free up space. Computes on other branches are not affected. Setting `logical_size_bytes` overrides any lower value set by the `neon.max_cluster_size` Postgres setting. Quotas are enforced using per-project consumption metrics with the same names. These metrics reset at the start of each billing period. `logical_size_bytes` is also an exception—it reflects the total data stored in a branch and does not reset. A zero or empty quota value means “unlimited.”

Show child attributes

active_time_secondsinteger · int64

The total amount of wall-clock time allowed to be spent by the project's compute endpoints.

minimum 0

compute_time_secondsinteger · int64

The total amount of CPU seconds allowed to be spent by the project's compute endpoints.

minimum 0

data_transfer_bytesinteger · int64

Total amount of data transferred from all of a project's branches using the proxy.

minimum 0

logical_size_bytesinteger · int64

Limit on the logical size of every project's branch. If a branch exceeds its `logical_size_bytes` quota, computes can still be started, but write operations will fail—allowing data to be deleted to free up space. Computes on other branches are not affected. Setting `logical_size_bytes` overrides any lower value set by the `neon.max_cluster_size` Postgres setting.

minimum 0

written_data_bytesinteger · int64

Total amount of data written to all of a project's branches.

minimum 0

store_passwordsbooleanrequired

Whether or not passwords are stored for roles in the Neon project. Storing passwords facilitates access to Neon features that require authorization.

synthetic_storage_sizeinteger · int64

The current space occupied by the project in Postgres storage, in bytes. Synthetic Postgres storage size combines the logical data size and Write-Ahead Log (WAL) size for all branches in a project.

updated_atstring · date-timerequired

A timestamp indicating when the project was last updated

unavailable_project_idsarray of string

A list of project IDs indicating which projects are known to exist, but whose details could not be fetched within the requested (or implicit) time limit

Show child attributes

Option 2objectPaginationResponse

paginationobject

Cursor-based pagination. The `cursor` value reflects the endpoint's sort field (for example, an ID or timestamp), so pass it back unchanged.

Example response

{
  "projects": [
    {
      "active_time": 100,
      "branch_logical_size_limit": 0,
      "branch_logical_size_limit_bytes": 10800,
      "cpu_used_sec": 0,
      "created_at": "2022-11-23T17:42:25Z",
      "creation_source": "console",
      "id": "shiny-wind-028834",
      "name": "shiny-wind-028834",
      "owner_id": "1232111",
      "pg_version": 15,
      "platform_id": "aws",
      "provisioner": "k8s-pod",
      "proxy_host": "us-east-2.aws.neon.tech",
      "region_id": "aws-us-east-2",
      "store_passwords": true,
      "updated_at": "2022-11-23T17:42:25Z"
    },
    {
      "active_time": 100,
      "branch_logical_size_limit": 0,
      "branch_logical_size_limit_bytes": 10800,
      "cpu_used_sec": 0,
      "created_at": "2022-11-23T17:52:25Z",
      "creation_source": "console",
      "id": "winter-boat-259881",
      "name": "winter-boat-259881",
      "owner_id": "1232111",
      "pg_version": 15,
      "platform_id": "aws",
      "provisioner": "k8s-pod",
      "proxy_host": "us-east-2.aws.neon.tech",
      "region_id": "aws-us-east-2",
      "store_passwords": true,
      "updated_at": "2022-11-23T17:52: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

cursorquery parameter

limitquery parameter

searchquery parameter

timeoutquery parameter

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

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

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

import requests

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

{
  "projects": [
    {
      "active_time": 100,
      "branch_logical_size_limit": 0,
      "branch_logical_size_limit_bytes": 10800,
      "cpu_used_sec": 0,
      "created_at": "2022-11-23T17:42:25Z",
      "creation_source": "console",
      "id": "shiny-wind-028834",
      "name": "shiny-wind-028834",
      "owner_id": "1232111",
      "pg_version": 15,
      "platform_id": "aws",
      "provisioner": "k8s-pod",
      "proxy_host": "us-east-2.aws.neon.tech",
      "region_id": "aws-us-east-2",
      "store_passwords": true,
      "updated_at": "2022-11-23T17:42:25Z"
    },
    {
      "active_time": 100,
      "branch_logical_size_limit": 0,
      "branch_logical_size_limit_bytes": 10800,
      "cpu_used_sec": 0,
      "created_at": "2022-11-23T17:52:25Z",
      "creation_source": "console",
      "id": "winter-boat-259881",
      "name": "winter-boat-259881",
      "owner_id": "1232111",
      "pg_version": 15,
      "platform_id": "aws",
      "provisioner": "k8s-pod",
      "proxy_host": "us-east-2.aws.neon.tech",
      "region_id": "aws-us-east-2",
      "store_passwords": true,
      "updated_at": "2022-11-23T17:52:25Z"
    }
  ]
}

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