API Reference

Users

Manage users in your project. All endpoints require a secret key and are server-side only.

Server-side only

All user management endpoints require your sk_live_ secret key. Never expose this in client-side code.

GET/v1/dashboard/users

List Users

List all users in the current project. Requires secret key.

Query Params

text

?limit=20&offset=0&search=john&projectId=proj_abc123

Response

json

{
  "users": [
    {
      "id": "usr_abc123",
      "email": "user@example.com",
      "displayName": "John Doe",
      "avatarUrl": null,
      "isBanned": false,
      "signInCount": 5,
      "lastSignInAt": "2026-01-15T10:30:00Z",
      "createdAt": "2026-01-01T00:00:00Z"
    }
  ],
  "total": 42
}

GET/v1/dashboard/users/:userId

Get User

Get a single user by ID with their linked providers and active sessions.

Response

json

{
  "id": "usr_abc123",
  "email": "user@example.com",
  "displayName": "John Doe",
  "providers": ["google", "github"],
  "sessions": [...],
  "publicMetadata": {}
}

PATCH/v1/dashboard/users/:userId/ban

Ban User

Ban a user. Revokes all active sessions and prevents future sign-ins.

Response

json

{ "success": true }

PATCH/v1/dashboard/users/:userId/unban

Unban User

Lift a ban from a user, allowing them to sign in again.

Response

json

{ "success": true }

DELETE/v1/dashboard/users/:userId

Delete User

Permanently delete a user and all their data. This action is irreversible.

Response

json

{ "success": true }