Skip to main content

Overview

Returns the authenticated user’s profile, their associated business (workspace), whether onboarding is complete, and their role within the business. Use this endpoint to bootstrap your application after login.

Request

Method: GET URL: /api/v1/auth/me

Headers

No request body is required.

Response

object
The authenticated user’s profile.
object | null
The business (workspace) associated with this user. null if onboarding is not complete.
boolean
true if the user has completed onboarding (i.e. a business record exists).
string | null
The user’s role within the business. One of "owner", "admin", "agent", or null if no business is associated.

Example

Response example

Errors