Developer API

Build on top of CorePath.

A predictable, JSON-first REST API. Generate QR codes, manage links, capture form submissions, and pull analytics straight into your own stack.

Base URL

All requests are versioned and sent over HTTPS.

https://api.getcorepath.com/v1

Authentication

Pass your secret API key as a Bearer token. Create and rotate keys from your workspace settings.

curl https://api.getcorepath.com/v1/insights \
  -H "Authorization: Bearer cp_live_8f2c4a9e7b13d05f" \
  -H "Content-Type: application/json"

Rate limits

Pro workspaces get 600 requests/minute per key. Limits are returned in the X-RateLimit-Remaining header; a 429 means back off and retry.

Example endpoints

A small slice of the surface area. Resources are namespaced per tool and share consistent pagination and error shapes.

POST/qr

Create a dynamic QR code and return its slug, image URLs, and redirect target.

GET/links/{id}

Retrieve a short link with its destination, tags, and lifetime click totals.

POST/forms/{id}/submissions

Submit a response to a published form, with file fields uploaded as multipart.

GET/insights

Query scans, clicks, and submissions across a date range, grouped by tool or geo.

Create a QR code

POST https://api.getcorepath.com/v1/qr
{
  "destination": "https://getcorepath.com/launch",
  "title": "Spring campaign",
  "style": { "fg": "#6E59FF", "corners": "rounded" }
}

Ready to integrate?

Read the full product docs for redirect endpoints, webhooks, and per-tool guides.

Read the docs