List CRM Trip Timeline | SalaryBox

curl -G https://api.salaryboxapp.com/v2/customer/v1/crm/trips/timeline \
     -H "Authorization: Api-Key  <apiKey>" \
     -d end_date=2026-10-31 \
     -d salarybox_ids=string \
     -d start_date=2026-10-01

{
  "data": [
    {
      "salarybox_id": "SBK7Q2M9TX",
      "employee_name": "Aarav Sharma",
      "total_distance_km": "14.35",
      "number_of_trips": 2,
      "trips": [
        {
          "is_valid": true,
          "distance_km": "14.35",
          "start_trip_data": {
            "date": "2026-10-28",
            "time": "2026-10-28T09:30:00+05:30",
            "timezone": "Asia/Kolkata",
            "odometer_reading": "10250.00",
            "latitude": "28.63042030",
            "longitude": "77.21669000",
            "address": "Connaught Place, New Delhi, Delhi 110001",
            "notes": "",
            "attachment_count": 1
          },
          "stop_trip_data": {
            "date": "2026-10-28",
            "time": "2026-10-28T10:20:00+05:30",
            "timezone": "Asia/Kolkata",
            "odometer_reading": "10264.35",
            "latitude": "28.54490000",
            "longitude": "77.19340000",
            "address": "Hauz Khas, New Delhi, Delhi 110016",
            "notes": "Reached the customer site",
            "attachment_count": 1
          }
        },
        {
          "is_valid": true,
          "distance_km": "0.00",
          "start_trip_data": {
            "date": "2026-10-29",
            "time": "2026-10-29T13:05:00+05:30",
            "timezone": "Asia/Kolkata",
            "odometer_reading": null,
            "latitude": "28.63042030",
            "longitude": "77.21669000",
            "address": null,
            "notes": "",
            "attachment_count": 0
          },
          "stop_trip_data": null
        }
      ]
    }
  ],
  "message": "Success",
  "status": true,
  "count": 1,
  "prev": null,
  "next": null,
  "rate_limit": [
    "0/1 requests remaining per 2 seconds",
    "29/30 requests remaining per 5 minutes",
    "99/100 requests remaining per 1 hour"
  ]
}

Returns every trip the named staff (1 to 10) logged in Field Force CRM, with where each started and stopped, for up to 31 days. 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. trips are oldest first, each with is_valid (whether the app’s CRM metrics count it), distance_km, start_trip_data and stop_trip_data.

Start and stop data have date, time (with offset), timezone, odometer_reading, latitude, longitude, address, notes and attachment_count. stop_trip_data is null while a trip is in progress. The planned destination and attachments are not returned.

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 stringsRequired

Required, repeatable, 1 to 10. The staff members whose trips are returned.

pageintegerOptional

Page number, starting at 1.

page_sizeintegerOptional<=25Defaults to 25

Results per page. Default and maximum 25.

Response

One row per requested staff member, each with the trips list.

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