Skip to content

Get the authenticated user

Returns the profile of the user that owns the token.

GET /api/v1/me
RequirementValue
HeaderAuthorization: Bearer <token>
Scoperead_user
Terminal window
curl https://your-app.com/api/v1/me \
-H "Authorization: Bearer YOUR_TOKEN"

200 OK

{
"data": {
"id": "01JABCDEF0123456789ABCDEFG",
"username": "jane",
"email_address": "[email protected]",
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"avatar": "https://your-app.com/storage/avatars/abc.png",
"organization_name": "Acme Inc"
}
}
FieldTypeDescription
idstringThe user’s unique identifier (ULID).
usernamestringThe user’s username.
email_addressstringThe user’s email address.
first_namestring | nullFirst name, if set.
last_namestring | nullLast name, if set.
full_namestring | nullFirst and last name combined; null unless both are set.
avatarstring | nullURL of the user’s avatar, if set.
organization_namestring | nullName of the organization the token belongs to.
StatusWhen
401 UnauthorizedMissing or invalid token.
403 ForbiddenThe organization’s plan doesn’t qualify, or the token lacks the read_user scope.
429 Too Many RequestsThe token’s monthly request limit is exhausted.