Skip to Content
APITripsGET

GET Trips

Gebruik dit endpoint om trips op te halen.

Gebruikersniveau: Gevorderd

Endpoint

GET /v1/{branchId}/trips
EigenschapWaarde
MethodGET
Scope IDBranch UUID
AuthenticatieAuthorization: Bearer <access_token>

Queryparameters

ParameterTypeDefaultMaxBeschrijving
limitinteger501000Aantal records per pagina.
offsetinteger0-Paginatie-offset.
sortstring-Sorteerexpressie in het formaat field:asc of field:desc.
filterstring-Filterexpressie in het formaat field:operator:value. Herhaal filter om meerdere filters te combineren.

Filteren en sorteren

Syntax

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

Je kunt filter meerdere keren in dezelfde request gebruiken.

Ondersteunde operators

OperatorBetekenis
eqExact gelijk aan
neNiet gelijk aan
inWaarde zit in een lijst
gtGroter dan
gteGroter dan of gelijk aan
ltKleiner dan
lteKleiner dan of gelijk aan
likeHoofdlettergevoelige tekstmatch
ilikeNiet-hoofdlettergevoelige tekstmatch
isnullControle op nullwaarde

Resource-regels

  • Filteren en sorteren is per resource gewhitelist.
  • organization_id en branch_id zijn gereserveerd voor server-side scoping en kunnen niet door clients gefilterd worden.
  • Tenant-scope blijft server-controlled.
  • Gebruik voor deze resource een branch UUID in {scopeId}.

Voorbeeldfilters voor trips

?filter=status:eq:planned ?filter=trip_number:ilike:%TRP% ?sort=trip_date:desc

Voorbeeldrequest

curl -X GET "https://api.routix.com/v1/550e8400-e29b-41d4-a716-446655440000/trips?limit=25&offset=0&sort=trip_date:desc&filter=status:eq:planned" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

Voorbeeldresponse voor v1

{ "data": [ { "id": "8c6f6b38-c46c-486d-9ee6-0b2ec458f3f1", "trip_number": "TRP-2026-0018", "trip_date": "2026-07-05", "vehicle_id": "91eb2f55-bc74-4ebb-a118-8d996a96f2f4", "driver_id": "e70d3a6a-799d-4a7d-88bd-0ad13f5211b4", "status": "planned", "planned_distance_km": 185, "is_charter": false, "carrier_account_id": "7ecf4b8d-8d1f-4a0f-8e57-6d8f14c6a221" } ], "pagination": { "limit": 10, "offset": 0, "total": 1 }, "version": "v1" }

Velden

VeldBeschrijving
idUUID van de trip.
trip_numberTripnummer.
trip_dateGeplande datum van de trip.
vehicle_idUUID van het voertuig.
driver_idUUID van de chauffeur.
statusHuidige status van de trip.
planned_distance_kmGeplande afstand in kilometers.
is_charterGeeft aan of het om een chartertrip gaat.
carrier_account_idUUID van de vervoerder.

Responseformaat

Succes: lijstresponse

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

Foutresponse

{ "error": "insufficient_scope", "error_description": "Token does not contain the required scope for trips" }

Gerelateerde pagina’s

  • API integratie
  • API calls en voorbeelden
  • Setup guide
Last updated on