Skip to navigation

List Location Tracking Requests

Returns tracking requests sent to staff, newest first, with the tracking session each one started. Requires the Location Tracking add-on. Includes inactive staff.

A request that is awaiting, declined or cancelled has session: null. A staff member’s first item is their latest request, so session.is_active there tells you whether they are being tracked now.

Authentication

AuthorizationApi-Key

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

Query parameters

salarybox_idslist of stringsOptional

Repeatable. Limits the result to these staff members, for example salarybox_ids=SBK7Q2M9TX&salarybox_ids=SBK3H8D1LP.

pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional
Results per page. Default and maximum 500.

Response

Tracking requests, newest first.
datalist of objects
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.

Errors

403
Forbidden Error