Skip to main content
Neon Postgres Docs
current

Search documentation

Type to search this documentation.

On this pageOverview

List projects

Retrieves a list of projects for the specified organization.

GET /projects

Retrieves a list of projects for the specified organization. If using a personal API key, include the org_id parameter to specify which organization to work with. If using an org API key, org_id is automatically inferred from the key. For more information, see Manage organizations using the Neon API and Manage projects.

Markdown for AI context

REST API - curl
curl "https://console.neon.tech/api/v2/projects" \
  -H "Authorization: Bearer $NEON_API_KEY"

Every field below is optional. An empty body works too.

Also available in

Bash
neon projects list

Tool: list_projects

List Neon projects in your account. Do not use for projects shared with you (use list_shared_projects instead). Supports optional search (filter by name or ID) and limit (default 10) parameters.

  • cursor (string, optional) Specify the cursor value from the previous response to retrieve the next batch of projects.
  • limit (number, optional, default: 10) Specify a value from 1 to 400 to limit number of projects in the response.
  • search (string, optional) Search by project name or id. You can specify partial name or id values to filter results.
  • org_id (string, optional) Search for projects by org_id.

Console path: Organization → Projects

Cursor

cursor

string

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

Limit

limit

integerdefault: 10

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

Search

search

string

Search by project name or id. You can specify partial name or id values to filter results.

Organization

org_id

string

Search for projects by org_id.

Timeout

timeout

integer

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

Recoverable

recoverable

booleandefault: false

Show only deleted projects within the recovery window.

200

Returned a list of projects for the Neon account

Depth

"applications": (object),req

"integrations": (object),req

"unavailable_project_ids": (array),

default

General error

This endpoint can return the standard Neon API error response.

Response fields

  • message Required. Human-readable error message.
  • code Required. Machine-readable error code.
  • request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu