Getting started

Get an API key and make your first call to the Jot API — create links, read analytics, and register webhooks from your own code.

Jot's dashboard and API draw from the same account and the same plan — anything you can do by clicking is also a /v1/* call, and vice versa.

1. Get an API key

Create an account, then open API Keys in the dashboard and generate one. The raw key is shown once — store it like a password.

2. Authenticate every request

Authorization: Bearer jot_live_<your-key>

Every key is scoped read and/or write, and rate-limited per your plan (see Rate limits). Responses carry X-RateLimit-Remaining/X-RateLimit-Limit headers on every call, not just the ones you get throttled on.

3. Create your first link

curl -X POST https://jot.co.zm/v1/links \
  -H "Authorization: Bearer jot_live_..." \
  -H "Content-Type: application/json" \
  -d '{"destinationUrl": "https://example.com/product-launch"}'

{
  "shortUrl": "https://jot.co.zm/aB3xQ",
  "shortCode": "aB3xQ",
  "destinationUrl": "https://example.com/product-launch",
  "expiresAt": null,
  "qrUrl": "https://jot.co.zm/api/qr/aB3xQ.svg"
}

Every endpoint

Method	Path	What it does
`POST`	`/v1/links`	Create a link
`GET`	`/v1/links`	List your links, keyset-paginated
`POST`	`/v1/links/bulk`	Create up to 5,000 links in one call
`GET`	`/v1/links/:id`	Get one link
`PATCH`	`/v1/links/:id`	Change a link's destination
`DELETE`	`/v1/links/:id`	Deactivate a link
`POST`	`/v1/webhooks`	Register a webhook (Team plan and above)
`GET`	`/v1/webhooks`	List your webhook subscriptions
`DELETE`	`/v1/webhooks/:id`	Remove a webhook
`GET`	`/v1/usage`	This month's link count, quota and clicks

Full detail on each area: Links, QR codes, Webhooks, Rate limits, Errors, or the complete API reference.