Developer API · Preview

Build on top of CorePath.

A preview of our planned JSON-first REST API for generating QR codes, managing links, capturing form submissions, and pulling analytics into your own stack.

In development

The public API isn't live yet — the endpoints below are a design preview. Want early access?

Join the waitlist

Base URL

All requests are versioned and sent over HTTPS.

https://api.getcorepath.com/v1

Authentication

Requests will authenticate with a secret API key as a Bearer token, created and rotated from your workspace settings.

# Planned — keys not yet available
curl https://api.getcorepath.com/v1/insights \
  -H "Authorization: Bearer cp_live_YOUR_KEY" \
  -H "Content-Type: application/json"

Rate limits

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

Planned endpoints

A preview of the surface area we're designing. Resources will be 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" }
}

Want early access?

Tell us what you'd build and we'll reach out when the API enters beta. In the meantime, explore the product docs.