Skip to content
User

Get User Profile

Retrieve authenticated user's profile data including personal details, account status, and subscription information

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
GEThttps://api.lobstr.io/v1/me

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

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Content-TypestringheaderDefault application/json

Content type of the request. Value: application/json

Response Field Explanations

first_namestring

User's first name. Example: "John"

last_namestring

User's last name. Example: "Doe"

emailstring

User's email address. Example: "user@example.com"

email_verifiedboolean

Whether the user's email address has been verified. Example: true

planarray

List of active subscription plan objects for the user.

plan[].is_legacyboolean

true on a grandfathered plan: crawler costs (credits_per_row, credits_per_function, credits_per_filter) then use their legacy rate, otherwise their current one. Example: false

login_countinteger

Total number of times the user has logged in. Example: 42

profile_imagestring | null

URL of the user's profile image, or null if not set.

is_staffboolean

Whether the user has staff/admin access. Example: false

credit_intervalstring

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"
}