Quickstart
The v1 API routes documented here live under /api/v1. Every route in this initial developer doc set requires an API key, and the shop scope is always resolved from that key.
Base path: /api/v1
Supported auth headers: x-api-key or Authorization: Bearer <key>
Missing or invalid keys return HTTP 401
Some routes return 404 if the shop, customer, or ticket does not exist in that scoped shop
x-api-key header
This is the simplest header form because the auth helper reads req.headers['x-api-key'] first.
GET with x-api-key
curl "$BASE_URL/api/v1/tickets/getRecentConversations?days=7" \
-H "x-api-key: <YOUR_API_KEY>"Bearer fallback
If x-api-key is not present, the auth helper will also accept an Authorization header and strip the Bearer prefix.
GET with Bearer auth
curl "$BASE_URL/api/v1/customers/123" \
-H "Authorization: Bearer <YOUR_API_KEY>"