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.
All requests to the lobstr.io API must include an Authorization header with your API token. You can obtain your API token from the API menu in your dashboard.
The authentication format follows the standard Token authentication scheme:
Authorization: Token YOUR_API_KEY
Once authenticated, you’ll have access to all API endpoints based on your account’s permission level and subscription plan.
Your API authentication token from the dashboard. Value: Token YOUR_API_KEY
Store your API key in environment variables rather than hardcoding it in your source code. This prevents accidental exposure in version control systems.
Never share your API key publicly or commit it to public repositories. Treat it like a password.
If you believe your API key has been compromised, regenerate it immediately from your dashboard. The old key will be invalidated.
Code Examples
curl -X GET "https://api.lobstr.io/v1/me" \
-H "Authorization: Token YOUR_API_KEY"
Response
{
"id": 12345,
"email": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"is_active": true,
"date_joined": "2024-01-15T10:30:00Z"
}