Sign in
Project

List projects

Changed on

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.

get/projects

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Query parameters

cursorstring

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

limitinteger

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

searchstring

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

org_idstring

Search for projects by org_id.

timeoutinteger

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

recoverableboolean

Show only deleted projects within the recovery window.

Response

Returned a list of projects for the Neon account

unavailable_project_idsstring[]

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

applicationsobject required

Map of project IDs to their installed applications. Each key is a project ID; each value is an array of application types (for example, vercel, github).

integrationsobject required

Map of project IDs to their associated integration details.

Example response

{
  "integrations": {
    "winter-boat-259881": [
      "vercel",
      "github",
      "datadog",
      "opentelemetry"
    ]
  }
}

Changes

  • 18c4e2b74446Revision changes
    • ○

      the response's property default value changed from 17 to 18 for the status

  • af816419f5e7Revision changes
    • ▲

      the ////// response property's max was increased from 18.00 to 19.00 for the response status