API calls & examples

https://api.routix.com/v1/{scopeId}/{resource}

GET https://api.routix.com/v1/550e8400-e29b-41d4-a716-446655440000/accounts

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

/v1/{scopeId}/{resource}

/v1/{scopeId}/{resource}/{id}

sort=field:asc
sort=field:desc
filter=field:operator:value

?limit=25&offset=0&sort=company_name:asc&filter=status:eq:active&filter=account_type:in:customer,carrier

?filter=status:eq:active
?filter=account_type:in:customer,carrier
?filter=created_at:gte:2026-01-01
?filter=company_name:ilike:%transport%
?filter=valid_until:lt:2026-12-31
?filter=comment:isnull:true
?sort=company_name:asc
?sort=created_at:desc

GET /v1/{scopeId}/accounts?limit=25&offset=0&sort=company_name:asc&filter=status:eq:active&filter=account_type:in:customer,carrier

{
  "data": [],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 123
  },
  "version": "v1"
}

PATCH /v1/{scopeId}/{resource}/{id}

PATCH /v1/{scopeId}/accounts/{id}

{
  "status": "active",
  "company_name": "Acme Transport B.V."
}

POST /v1/{scopeId}/{resource}

POST /v1/{scopeId}/accounts

{
  "company_name": "Acme Transport B.V.",
  "email": "[email protected]",
  "phone": "+31 20 123 4567",
  "account_type": "customer",
  "status": "active"
}

DELETE /v1/{scopeId}/{resource}/{id}

DELETE /v1/{scopeId}/accounts/{id}

DELETE /v1/{scopeId}/quotations/{id}

const ROUTIX_URL = 'https://api.routix.com';
 
async function getToken(clientId, clientSecret) {
  const res = await fetch(`${ROUTIX_URL}/v1/oauth/token`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    grant_type: 'client_credentials',
    client_id: clientId,
    client_secret: clientSecret,
  }),
  });
 
  if (!res.ok) {
  const err = await res.json();
  throw new Error(`Auth failed: ${err.error_description}`);
  }
 
  const data = await res.json();
  return data.access_token;
}
 
async function callApi(token, scopeId, resourcePath) {
  const url = `${ROUTIX_URL}/v1/${scopeId}/${resourcePath}`;
  const res = await fetch(url, {
  headers: { Authorization: `Bearer ${token}` },
  });
 
  if (!res.ok) {
  const err = await res.json();
  throw new Error(`API error: ${err.error_description}`);
  }
 
  return res.json();
}

import requests
 
ROUTIX_URL = "https://api.routix.com"
 
 
def get_token(client_id: str, client_secret: str) -> str:
  response = requests.post(
    f"{ROUTIX_URL}/v1/oauth/token",
    json={
      "grant_type": "client_credentials",
      "client_id": client_id,
      "client_secret": client_secret,
    },
  )
  response.raise_for_status()
  return response.json()["access_token"]
 
 
def call_api(token: str, scope_id: str, resource_path: str) -> dict:
  response = requests.get(
    f"{ROUTIX_URL}/v1/{scope_id}/{resource_path}",
    headers={"Authorization": f"Bearer {token}"},
  )
  response.raise_for_status()
  return response.json()

<?php
 
$routixUrl = 'https://api.routix.com';
 
function getToken(string $clientId, string $clientSecret): string {
  global $routixUrl;
 
  $ch = curl_init("$routixUrl/v1/oauth/token");
  curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode([
      'grant_type' => 'client_credentials',
      'client_id' => $clientId,
      'client_secret' => $clientSecret,
    ]),
  ]);
 
  $response = json_decode(curl_exec($ch), true);
  $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  curl_close($ch);
 
  if ($httpCode !== 200) {
    throw new Exception('Auth failed: ' . ($response['error_description'] ?? 'Unknown error'));
  }
 
  return $response['access_token'];
}
 
function callApi(string $token, string $scopeId, string $resourcePath): array {
  global $routixUrl;
 
  $ch = curl_init("$routixUrl/v1/$scopeId/$resourcePath");
  curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
  ]);
 
  $response = json_decode(curl_exec($ch), true);
  $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  curl_close($ch);
 
  if ($httpCode !== 200) {
    throw new Exception('API error: ' . ($response['error_description'] ?? 'Unknown error'));
  }
 
  return $response;
}

using System.Net.Http.Headers;
using System.Net.Http.Json;
 
var routixUrl = "https://api.routix.com";
var httpClient = new HttpClient();
 
var tokenResponse = await httpClient.PostAsJsonAsync(
  $"{routixUrl}/v1/oauth/token",
  new {
    grant_type = "client_credentials",
    client_id = "your-client-id",
    client_secret = "routix_a1b2c3d4..."
  });
 
var tokenData = await tokenResponse.Content.ReadFromJsonAsync<Dictionary<string, object>>();
var token = tokenData!["access_token"].ToString();
 
httpClient.DefaultRequestHeaders.Authorization =
  new AuthenticationHeaderValue("Bearer", token);
 
var response = await httpClient.GetFromJsonAsync<object>(
  $"{routixUrl}/v1/550e8400-e29b-41d4-a716-446655440000/accounts?limit=25&offset=0&sort=company_name:asc&filter=status:eq:active");