GET/v1/me

Get User Profile

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

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

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes
Content-Type	application/json	No

Response Field Explanations

string

Unique user identifier

Example: user_abc123xyz789

string

User's email address

Example: user@example.com

name

string

User's full name

Example: John Doe

username

string

User's username

Example: johndoe

is_verified

boolean

Whether the user's email has been verified

Example: true

is_active

boolean

Whether the user account is active

Example: true

subscription_plan

string

Current subscription plan (free, basic, pro, enterprise)

Example: pro

subscription_status

string

Status of the subscription (active, cancelled, expired, trial)

Example: active

max_concurrency

integer

Maximum number of concurrent operations allowed

Example: 20

max_squids

integer

Maximum number of squids allowed

Example: 100

created_at

string

Timestamp when the account was created

Example: 2023-06-15T10:30:00Z

last_login

string

Timestamp of the user's last login

Example: 2024-01-20T08:45:00Z

Pro Tip

Use this endpoint to verify your authentication is working before making other API calls. A successful response means your API key is valid.

Note

The response includes rate limit information in the headers. Check the `X-RateLimit-Remaining` header to monitor your API usage.