List functions on the branch

API Reference / Functions / List functions on the branch

Lists functions on the specified branch.

Note: This endpoint is currently in Beta.

• project_id (string, path, required) The Neon project ID
• branch_id (string, path, required) The Neon branch ID
• cursor (string, query, optional) 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.
• limit (integer, query, optional) Specify a value from 1 to 1000 to limit number of functions in the response

{
  "functions": [
    {
      "id": "myfunction",
      "slug": "myfunction",
      "name": "myfunction",
      "invocation_url": "https://br-young-forest-a5b6c7d8-myfunction.compute.c-5.us-east-2.aws.neon.tech/",
      "current_deployment": {
        "id": 4,
        "status": "completed",
        "memory_mib": 2048,
        "runtime": "nodejs24",
        "created_at": "2025-01-15T10:30:00Z"
      },
      "active_deployment": {
        "id": 4,
        "status": "completed",
        "memory_mib": 2048,
        "runtime": "nodejs24",
        "created_at": "2025-01-15T10:30:00Z"
      },
      "created_at": "2025-01-15T11:00:00Z"
    }
  ],
  "pagination": {}
}

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/functions" \
  -H "Authorization: Bearer $NEON_API_KEY"

import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.listProjectBranchFunctions({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID
  }
});

# neonctl
neon functions list

default General 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.

• request_id (string, optional) 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.

• code (string, required) Machine-readable code classifying the error type. See message for a human-readable explanation. Default: ``

• message (string, required) Error message