Skip to navigation
API ReferenceCRM

List CRM Trips

Returns each staff member’s total distance and number of trips logged in Field Force CRM, for up to 31 days. Individual trips are not returned; use List CRM Trip Timeline. Requires the Field Force CRM add-on.

One row per staff member, active or inactive, ordered by salarybox_id; staff with nothing in the range are still listed. A trip counts on the day it was started, even if it stopped later. total_distance_km is a 2-decimal string.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

start_datedateRequired

First day, YYYY-MM-DD.

end_datedateRequired

Last day, YYYY-MM-DD. The range can cover at most 31 days.

salarybox_idslist of stringsOptional
Repeatable, at most 10. Limits the result to these staff members.
pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional<=25Defaults to 25
Results per page. Default and maximum 25.

Response

One summary row per staff member.
datalist of objects
One row per staff member on this page.
messagestringOptional
statusbooleanOptional
countintegerOptional
Total number of results across all pages.
prevstring or nullOptional
URL of the previous page, or null.
nextstring or nullOptional
URL of the next page, or null.
rate_limitlist of stringsOptional

What is left in each rate-limit window, for example 29/30 requests remaining per 5 minutes.

Errors

400
Bad Request Error
403
Forbidden Error
429
Too Many Requests Error