Skip to content
Getting Started

Authentication

Learn how to authenticate your API requests using token-based authentication

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

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.

Headers

Authorizationstringheaderrequired

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

A successful call confirms your token is valid and returns your profile. See Get User Profile for the full response schema.

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