Skip to content
SupaCloud Docs
Select themeSelect language

GET /api/admin/users/pending — list users awaiting approval (admin only)

GET
/api/admin/users/pending
curl --request GET \
  --url https://example.com/api/admin/users/pending

Responses

Section titled “Responses”

200

Section titled “200”

List of pending users

Media typeapplication/json
Array<object>

Spec-only projection of one pending (awaiting-approval) user row — the body element of GET /api/admin/users/pending. The nullable-but-always-present email/display_name carry #[schema(required)] (mirroring [MeResponse]) so the generated frontend zod keeps them required-yet-nullable.

object
created_at
required
string format: date-time
display_name
required

The user’s display name; null when unset.

string | null
email
required

The user’s email; null for an identity without a stored email.

string | null
id
required
string format: uuid
Examplegenerated
[
  {
    "created_at": "2026-04-15T12:00:00Z",
    "display_name": "example",
    "email": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
]

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}