Skip to main content
GET
/
v1
/
me
Get User Profile
curl --request GET \
  --url https://api.lobstr.io/v1/me \
  --header 'Authorization: <authorization>'
{
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "email_verified": true,
  "plan": [
    {}
  ],
  "login_count": 123,
  "profile_image": {},
  "is_staff": true,
  "credit_interval": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

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

This endpoint returns the authenticated user’s complete profile data in a single API call. Use it to verify authentication, retrieve user details, and check account status. This is typically the first endpoint you’ll call after authentication to confirm your credentials are working correctly.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
​
Content-Type
string
default:"application/json"
Content type of the request. Value: application/json

​
Response Field Explanations

​
first_name
string
User’s first name. Example: "John"
​
last_name
string
User’s last name. Example: "Doe"
​
email
string
User’s email address. Example: "user@example.com"
​
email_verified
boolean
Whether the user’s email address has been verified. Example: true
​
plan
array
List of active subscription plan objects for the user.
​
login_count
integer
Total number of times the user has logged in. Example: 42
​
profile_image
string | null
URL of the user’s profile image, or null if not set.
​
is_staff
boolean
Whether the user has staff/admin access. Example: false
​
credit_interval
string
The user’s credit reset interval (e.g., monthly billing cycle). Example: "monthly"
Use this endpoint to verify your authentication is working before making other API calls. A successful response means your API key is valid.
The response includes rate limit information in the headers. Check the X-RateLimit-Remaining header to monitor your API usage.

​
Code Examples

curl -X GET "https://api.lobstr.io/v1/me" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Response

200
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "user@example.com",
  "email_verified": true,
  "plan": [],
  "login_count": 42,
  "profile_image": null,
  "is_staff": false,
  "credit_interval": "monthly"
}