Skip to main content
GET
/
api
/
v1
/
users
/
me
Get Current User
curl --request GET \
  --url https://api.bunship.com/api/v1/users/me \
  --header 'Authorization: Bearer <token>'
{
  "id": "usr_cld2abc123def456",
  "email": "user@example.com",
  "emailVerified": "2024-01-15T10:30:00Z",
  "fullName": "John Doe",
  "avatarUrl": "https://cdn.bunship.com/avatars/usr_cld2abc123.jpg",
  "preferences": {
    "theme": "dark",
    "language": "en",
    "timezone": "America/New_York",
    "notifications": {
      "email": true,
      "push": false
    }
  },
  "twoFactorEnabled": false,
  "isActive": true,
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-20T14:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bunship.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the profile information for the currently authenticated user.

​
Auth

Requires a valid Bearer token.

​
Response

​
id
string
Unique user identifier.
​
email
string
User’s email address.
​
emailVerified
string | null
ISO 8601 timestamp of when the email was verified, or null if unverified.
​
fullName
string | null
User’s display name.
​
avatarUrl
string | null
URL of the user’s avatar image.
​
preferences
object
User preferences including theme ("light", "dark", "system"), language, timezone, and notifications settings.
​
twoFactorEnabled
boolean
Whether two-factor authentication is enabled.
​
isActive
boolean
Whether the account is active.
​
createdAt
string
ISO 8601 account creation timestamp.
​
updatedAt
string
ISO 8601 last update timestamp.
{
  "id": "usr_cld2abc123def456",
  "email": "user@example.com",
  "emailVerified": "2024-01-15T10:30:00Z",
  "fullName": "John Doe",
  "avatarUrl": "https://cdn.bunship.com/avatars/usr_cld2abc123.jpg",
  "preferences": {
    "theme": "dark",
    "language": "en",
    "timezone": "America/New_York",
    "notifications": {
      "email": true,
      "push": false
    }
  },
  "twoFactorEnabled": false,
  "isActive": true,
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-20T14:30:00Z"
}

​
Errors

StatusCodeDescription
401AUTHENTICATION_ERRORMissing or invalid Bearer token
404NOT_FOUNDUser account not found or deactivated

​
Example

curl https://api.bunship.com/api/v1/users/me \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."