Skip to content
Proud to collaborate with Microsoft for Startups

neon.projects.list ​

List all Neon projects in the account

List all Neon projects in the account (paginated).

Inputs:

  • limit: max projects per page (optional; default 10, capped at 100).
  • cursor: pagination cursor returned by a previous call (optional).

Outputs (terminal state_data):

  • projects: list of provider-level project objects; each item includes id, name, region_id, pg_version (and other Neon fields). Callers must use id as an opaque provider reference — Neon IDs are not sequential.
  • next_cursor: str — cursor for the next page, or empty when exhausted.

Error policy:

  • 4xx → WorkflowNotRetryableError (via _common.raise_for_neon_status).
  • 5xx / timeouts → propagate so the engine retries.

Plugin required: context.get_plugin("neon") must expose .api_token.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-neon
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—Cloud connection holding the Neon credential
limitintegerNo—Max projects per page (default 10, cap 100)
cursorstringNo—Pagination cursor from a previous call

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo——
projectslistNo——
next_cursorstringNo——
limitintegerNo——
cursorstringNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "neon.projects.list",
  "initial_data": {
    "connection_uuid": "value",
    "limit": 123,
    "cursor": "value"
  }
}