Overview

Overview

The Linxly API is a REST API that returns JSON responses. It uses standard HTTP methods and status codes.

Get Your API Key

  1. Log in to linx.ly (opens in a new tab)
  2. Go to Dashboard → Settings
  3. Copy your API key

Base URL

https://api.linx.ly

API Version

All endpoints are prefixed with /v1. Breaking changes ship under a new version prefix.

Request format

  • Set Accept: application/json on every request
  • For POST and PUT requests, send a JSON body with Content-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.