Auth

The signed-in user and their session

GET /api/me

Access: any signed-in user, for their own data; personal access tokens need user.email:read.

Responses

• 200 Success
  • user object required
    • id string (uuid) required
    • email string | null required
    • name string | null required
    • avatarUrl string | null required
    • isSystemAdmin boolean required
  • session object required
    • createdAt string (date-time) required
    • expiresAt string (date-time) required
    • authenticatedAt string (date-time) | null
  • impersonation object | null
    • adminEmail string | null required
    • expiresAt string (date-time) required
• 401 Not signed in
• 429 Too many requests: a rate limit was reached (see Retry-After)

What deleting your account would do to the workspaces you own

GET /api/me/deletion

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Responses

• 200 Success
  • email string | null required
  • workspaces array of object required
    • id string (uuid) required
    • name string required
    • outcome "delete" | "leave" | "blocked" required
    • others integer required
  • reauthenticatedUntil string (date-time) | null required
• 401 Not signed in
• 429 Too many requests: a rate limit was reached (see Retry-After)

Delete your account: signed out everywhere, data hard-deleted within 30 days

POST /api/me/delete

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Request body

• confirmEmail string required

Responses

• 200 Success
  • purgeBy string (date-time) required
  • workspaces integer required
• 401 Not signed in
• 422 The request failed validation
• 429 Too many requests: a rate limit was reached (see Retry-After)

When OpenRows staff viewed your account as you, read-only

GET /api/me/support-access

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Responses

• 200 Success
  • entries array of object required
    • startedAt string (date-time) required
    • expiresAt string (date-time) required
    • reason string | null required
• 401 Not signed in
• 429 Too many requests: a rate limit was reached (see Retry-After)

End a system admin's impersonation of this account in this session

DELETE /api/me/impersonation

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Responses

• 204 Success, no content
• 401 Not signed in
• 429 Too many requests: a rate limit was reached (see Retry-After)