API calls & examples

https://api.routix.com/functions/v1/api/{version}/{publicBranchId}/{resource}

GET https://api.routix.com/functions/v1/api/v1/RS2RDH3B/accounts

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

GET /functions/v1/api/v1/{branchId}/accounts

curl -X GET "https://api.routix.com/functions/v1/api/v1/RS2RDH3B/accounts?limit=10&offset=0" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "company_name": "Acme Transport B.V.",
      "email": "info@acmetransport.nl",
      "phone": "+31 20 123 4567",
      "account_type": "customer",
      "status": "active"
    },
    {
      "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
      "company_name": "FastFreight Logistics",
      "email": "contact@fastfreight.nl",
      "phone": "+31 30 987 6543",
      "account_type": "carrier",
      "status": "active"
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 2
  },
  "version": "v1"
}

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

{
  "error": "insufficient_scope",
  "error_description": "Token does not contain the required scope: routix:accounts:read"
}

const ROUTIX_URL = 'https://api.routix.com';
 
async function getToken(clientId, clientSecret) {
  const res = await fetch(`${ROUTIX_URL}/functions/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 getAccounts(token, branchId, { limit = 50, offset = 0 } = {}) {
  const url = `${ROUTIX_URL}/functions/v1/api/v1/${branchId}/accounts?limit=${limit}&offset=${offset}`;
  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}/functions/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 get_accounts(token: str, branch_id: str, limit: int = 50, offset: int = 0) -> dict:
    response = requests.get(
        f"{ROUTIX_URL}/functions/v1/api/v1/{branch_id}/accounts",
        headers={"Authorization": f"Bearer {token}"},
        params={"limit": limit, "offset": offset},
    )
    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/functions/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'];
}

using System.Net.Http.Headers;
using System.Net.Http.Json;
using System.Text.Json;
 
var routixUrl = "https://api.routix.com";
var httpClient = new HttpClient();
 
var tokenResponse = await httpClient.PostAsJsonAsync(
    $"{routixUrl}/functions/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 accounts = await httpClient.GetFromJsonAsync<JsonElement>(
    $"{routixUrl}/functions/v1/api/v1/RS2RDH3B/accounts?limit=10");