Get current user profile

GET

/me

const url = 'https://example.com/api/me';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/me \
  --header 'Authorization: Bearer <token>'

Returns the authenticated user’s profile including billing plan, GitHub connection status, and team membership.

Authorizations

bearerApiKey
cookieAuth

Responses

200

User profile

application/json

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

email

required

string format: email

/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

name

required

Any of:

string
null

string

authMethod

required

string

Allowed values: session api-key

plan

required

string

Example

free

planLabel

required

string

Example

Free

billingAccountId

required

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

superadmin

required

boolean

is_superadmin

required

Snake_case alias of superadmin for legacy portal clients

boolean

hasActiveBilling

required

boolean

_pending

required

Reserved; always false for authenticated GET /me

boolean

github

required

object

connected

required

boolean

username

required

Any of:

string
null

string

team

required

object

role

required

Any of:

string
null

string

Allowed values: owner member

size

required

integer

>= -9007199254740991 <= 9007199254740991

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean