Developers

API Documentation

Build integrations, automate link management, and connect returnbob to your stack. REST API, JSON, Bearer auth.

v1 Stable https://www.returnbob.com/api/v1

Authentication

API access requires Developer plan or higher. Get your key in Settings → API.

Authorization: Bearer rtb_live_your_api_key

api

Health & Auth

GET /api/v1/health Check API status — no auth required

POST /api/v1/auth/login Get token from email + password

POST /api/v1/auth/register Create new account

person

User

GET /api/v1/me Get current user profile

GET /api/v1/api-key Check API key status (masked)

POST /api/v1/api-key Generate new API key

DELETE /api/v1/api-key Revoke API key

link

Links

GET /api/v1/links List links (paginated, sortable)

POST /api/v1/links Create link (auto-fetches OG meta)

GET /api/v1/links/{id} Get single link

PUT /api/v1/links/{id} Update link

DELETE /api/v1/links/{id} Delete link

GET /api/v1/links/{id}/clicks Click analytics (days param)

GET /api/v1/links/{id}/qr QR code URL (size, color params)

bar_chart

Analytics & Search

GET /api/v1/analytics Aggregated stats (days param)

GET /api/v1/search Full-text link search

public

Public

GET /api/v1/public/{slug} Get public link info (no auth)

GET /api/v1/analyze Analyze URL for import config

Quick Example

curl -X POST "https://www.returnbob.com/api/v1/links" \
  -H "Authorization: Bearer rtb_live_..." \
  -H "Content-Type: application/json" \
  -d '{"destination_url":"https://example.com","title":"My Link"}'

Error Codes

400 Bad Request

401 Unauthorized

403 Forbidden

404 Not Found

409 Conflict

429 Rate Limited

settings

Need API access?

Upgrade to Developer or Pro in Settings → Billing.