Overview
The Linxly API is a REST API that returns JSON responses. It uses standard HTTP methods and status codes.
Get Your API Key
- Log in to linx.ly (opens in a new tab)
- Go to Dashboard → Settings
- Copy your API key
Base URL
https://api.linx.lyAPI Version
All endpoints are prefixed with /v1. Breaking changes ship under a new version prefix.
Request format
- Set
Accept: application/jsonon every request - For
POSTandPUTrequests, send a JSON body withContent-Type: application/json
Response format
All responses return a JSON object. Successful responses wrap data in a data key:
{
"data": { ... }
}Paginated list responses include links and meta keys alongside data.
HTTP status codes
200 success. All other codes indicate errors — see Error Codes for full reference.
All API requests must include a valid Bearer token. See Authentication.