Neon API (unofficial showcase)
GET/users/me

Retrieve current user details

Retrieves information about the currently authenticated Neon user, including account identifiers, plan details, and linked auth accounts.

2 status codes
200Returned information about the current user
active_seconds_limitintegerrequired
Control plane observes active endpoints of a user this amount of wall-clock time.
billing_accountobjectoptional
Billing account associated with the current user, including plan and subscription details.
auth_accountsarray<object>required
Authentication provider accounts linked to the current user.
emailstringrequired
Email address of the authenticated user.
idstringrequired
The Neon user ID.
imagestringrequired
URL of the user's profile avatar image.
loginstringdeprecatedrequired
Deprecated. Use the `email` field.
namestringrequired
First name of the current user.
last_namestringrequired
Last name of the current user.
projects_limitintegerrequired
Maximum number of projects the account is allowed to create under the current plan.
branches_limitintegerrequired
Maximum number of branches allowed for the account under the current plan.
max_autoscaling_limitnumberrequired
The maximum autoscaling limit in Compute Units. A value of 0 indicates no limit is configured.
compute_seconds_limitintegeroptional
Maximum Postgres compute time, in seconds, allowed under the account's current plan.
planstringrequired
Current billing plan for the user's account.
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.
request_idstringoptional
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.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

Any other status is an error: 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.