API OverviewCopy Anchor Link

The Linkit REST API provides programmatic access to your product catalog, inventory, orders, offers, customers, and payments. All endpoints follow consistent conventions for authentication, pagination, and error handling. Order read responses use a versioned envelope with a normalized order payload (Orders).

Base URLCopy Anchor Link

Two spellings, one API. The same route table answers on both, against the same process, and neither is going away — use whichever reads better in your client:

https://linkit.works/api/v1
https://api.linkit.works/v1

The first is what the SDKs and the OpenAPI document below name. The second supplies the /api segment from the hostname instead of the path, which is what most people expect when they are handed "the API host"; the edge rewrites it onto the first, so a request is indistinguishable at the server.

All endpoints are prefixed with /api/v1 (or /v1 on api.linkit.works). HTTPS is required for all requests. The OpenAPI document is published at /docs/swagger.json (and served by the API itself at GET /api/v1/docs/swagger.json).

Request FormatCopy Anchor Link

• Content-Type: application/json for all request bodies
• Character encoding: UTF-8
• Date format: ISO 8601 / RFC 3339 (e.g., 2024-01-15T10:30:00Z)
• IDs: 15-character alphanumeric strings (Linkit resource identifiers)

AuthenticationCopy Anchor Link

Every request requires one of two authentication methods:

Bearer TokenCopy Anchor Link

Authorization: Bearer your_token_here

Obtained by authenticating with email and password. Tokens expire after a configurable period.

API KeyCopy Anchor Link

Authorization: your_api_key_here

Generated from the admin dashboard. Better suited for server-to-server communication.

See Authentication for full details.

HTTP MethodsCopy Anchor Link

Status CodesCopy Anchor Link

PaginationCopy Anchor Link

List endpoints return paginated results:

{
  "data": [],
  "count": 25,
  "total_count": 1234,
  "page": 1,
  "limit": 25,
  "has_next": true,
  "meta": {}
}

Query ParametersCopy Anchor Link

SortingCopy Anchor Link

Use the sort parameter for custom ordering:

GET /api/v1/products?sort=name_en
GET /api/v1/products?sort=-created

Prefix with - for descending order. Default sort is -created (newest first).

FilteringCopy Anchor Link

Resources support field-level filtering through query parameters:

GET /api/v1/products?is_enabled=true&brand_id=brand_123
GET /api/v1/orders?status=delivered&source=salla
GET /api/v1/customers?type=vip&status=active

Text SearchCopy Anchor Link

Most list endpoints support a search parameter for full-text search across relevant fields:

GET /api/v1/products?search=paracetamol

Error Response FormatCopy Anchor Link

All errors follow a consistent structure:

{
  "code": 400,
  "error": "Validation failed",
  "details": {
    "field": "name_en",
    "message": "Name is required"
  }
}

Rate LimitingCopy Anchor Link

API requests are rate-limited per organization. When you exceed the limit, the API returns 429 Too Many Requests with a Retry-After header indicating how long to wait.

Standard limits:

Common PatternsCopy Anchor Link

Iterate All PagesCopy Anchor Link

async function fetchAll(endpoint, token) {
  const results = [];
  let page = 1;
  let hasNext = true;

  while (hasNext) {
    const response = await fetch(
      `https://linkit.works/api/v1/${endpoint}?page=${page}&limit=100`,
      { headers: { 'Authorization': `Bearer ${token}` } }
    );
    const data = await response.json();
    results.push(...data.data);
    hasNext = data.has_next;
    page++;
  }

  return results;
}

Next StepsCopy Anchor Link