Authentication

Test authentication

Simple endpoint to test if authentication credentials are valid. Returns authentication status, company/user info, and the scopes granted to the token. Useful for debugging during development.

GET

/auth/test

Test authentication

curl --request GET \
  --url https://api.getrotor.com/open-api/auth/test \
  --header 'x-api-key: <api-key>' \
  --header 'rotor-api-version: 1.1.0'

{
  "auth_method": "api_key",
  "authenticated": true,
  "company_id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Authentication successful",
  "scopes": [
    "leads:read",
    "customers:read"
  ],
  "status": "success",
  "timestamp": "2026-01-15T14:30:00Z",
  "user_id": null
}

Authorizations

x-api-keystringheaderrequired

Company API key in the format: rotor_{keyId}_{keySecret}

To obtain an API key:

Log into your Rotor dashboard
Go to Settings → Integrations → API Keys
Create a new key and select the scopes you need
Copy the key — it's only shown once!

Headers

rotor-api-versionenum<string>headerdefault:1.1.0required

Required OpenAPI version header.

Available options: 1.1.0

Example: 1.1.0

Response

Authentication successful

auth_methodenum<string>

Available options: api_key, unknown

Example: api_key

authenticatedboolean

Example: true

company_idstring

Example: 550e8400-e29b-41d4-a716-446655440000

messagestring

Example: Authentication successful

rotor_api_versionstring

Example: 1.1.0

scopesstring[]

Scopes granted to this token

statusstring

Example: success

timestampstring

Example: 2026-01-15T14:30:00Z

user_idstring | null

Null for API key authentication

Still need help? Ask the team