Get the authenticated user
Returns the profile of the user that owns the token.
GET /api/v1/meAuthorization
Section titled “Authorization”| Requirement | Value |
|---|---|
| Header | Authorization: Bearer <token> |
| Scope | read_user |
Example request
Section titled “Example request”curl https://your-app.com/api/v1/me \ -H "Authorization: Bearer YOUR_TOKEN"Response
Section titled “Response”200 OK
{ "data": { "id": "01JABCDEF0123456789ABCDEFG", "username": "jane", "first_name": "Jane", "last_name": "Doe", "full_name": "Jane Doe", "avatar": "https://your-app.com/storage/avatars/abc.png", "organization_name": "Acme Inc" }}Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
id | string | The user’s unique identifier (ULID). |
username | string | The user’s username. |
email_address | string | The user’s email address. |
first_name | string | null | First name, if set. |
last_name | string | null | Last name, if set. |
full_name | string | null | First and last name combined; null unless both are set. |
avatar | string | null | URL of the user’s avatar, if set. |
organization_name | string | null | Name of the organization the token belongs to. |
Errors
Section titled “Errors”| Status | When |
|---|---|
401 Unauthorized | Missing or invalid token. |
403 Forbidden | The organization’s plan doesn’t qualify, or the token lacks the read_user scope. |
429 Too Many Requests | The token’s monthly request limit is exhausted. |