Connect Twilee directly with your own tools and workflows.

With an API key, your team can bring Twilee’s power directly into your tech stack — automate QR code generation, capture live scan data, and integrate intelligent tracking into your products, all with just a few lines of code.

Overview

Each team can create one API Key.
The API currently supports read-only operations (GET requests).
All endpoints return data in JSON format.
Pagination is supported for collection endpoints.

Base URL

https://api.twilee.com

Authentication

All requests must include your API key as a Bearer token in the Authorization header.

Example:

GET /qr_codes HTTP/1.1
Host: api.twilee.com
Authorization: Bearer YOUR_API_KEY
Accept: application/json

Available Endpoints

Resource	Description	Methods
`/qr_codes`	List all QR codes	`GET`
`/qr_codes/{id}`	Retrieve a specific QR code	`GET`
`/qr_codes/{id}/scans`	List scans for a QR code	`GET`
`/qr_codes/{id}/page-views`	List page views for a QR code	`GET`

Example Request

curl -X GET "https://api.twilee.com/qr_codes"   -H "Authorization: Bearer YOUR_API_KEY"   -H "Accept: application/json"

Example Integration (JavaScript)

const response = await fetch('https://api.twilee.com/qr_codes', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Accept': 'application/json'
  }
});

const data = await response.json();
console.log(data.member);

Error Handling

Code	Meaning	Description
`200`	OK	Request succeeded
`401`	Unauthorized	Missing or invalid API key
`404`	Not Found	The requested resource does not exist
`429`	Too Many Requests	Rate limit exceeded
`500`	Server Error	An unexpected error occurred

✅ You’re all set!
Use your API key to fetch QR code analytics, monitor engagement, and keep your apps in sync with your Twilee dashboard.

Getting started