Admin/Lookup/get_user_drivers_rep

`get_user_drivers_rep`token required

Returns the authenticated user's driver roster in the report ('rep') shape — the same drivers as get_user_drivers plus reporting fields. Paginated.

Try in playground

POST/api— body field action.name = "get_user_drivers_rep"

Parameters

Name	Type	Required	Description
`active_drivers`	number	optional	Active-state filter: 1 = active only, 0 = inactive only, 2 = both. An out-of-range value returns action_value '1'.e.g. `2`
`driver_id`	number	optional	Optional driver id (positive integer) to return a single driver.e.g. `479149`
`group_id`	number	optional	Optional group id (positive integer) to scope to one group.e.g. `36536`

Pagination

This action is paginated. The two parameters below are accepted on every call (both optional); omitting them yields page 1 with 100 rows. The response carries a pagination envelope alongside data; iterate while has_more === true.

page, page_size and has_more are present on every paginated response. total_count and total_pages are returned only by some actions — treat them as optional and drive iteration from has_more rather than from a page count worked out in advance.

Name	Type	Required	Description
`page_number`	number	optional	1-based page index. Defaults to 1 if omitted. Page 1 pins a snapshot for stateful actions (events, telemetry) — subsequent pages reuse that snapshot until the session expires (~30 minutes).e.g. `1`
`page_size`	number	optional	Rows per page. Defaults to 2000, which is also the maximum — larger values are silently capped to 2000, and a response of exactly 2000 rows usually means there are more pages. For stateful actions (events, telemetry) only the value sent with page 1 is honored, because later pages reuse the size pinned by the snapshot; stateless actions read it on every request.e.g. `2000`

Iterate every page

curl

# Iterate every page until pagination.has_more is false.
# page_size "100" is a deliberate small page so the loop is visible — the
# default is 2000, which is also the maximum. Raise it to fetch fewer,
# larger pages; you still stop on has_more either way.
# Requires: jq (https://stedolan.github.io/jq/).
page=1
while :; do
  body=$(curl -s -X POST 'https://private.stage.questar.io/v2/private-questar-units/api' \
    -H 'Content-Type: application/json' \
    -H 'Authorization: Bearer YOUR_TOKEN' \
    -d '{"action":{"name":"get_user_drivers_rep","parameters":[{"active_drivers":2,"driver_id":479149,"group_id":36536,"page_number":"'$page'","page_size":"100"}]}}')
  echo "$body" | jq '.response.properties.data[]'
  has_more=$(echo "$body" | jq -r '.response.properties.pagination.has_more // false')
  [ "$has_more" = "true" ] || break
  page=$((page + 1))
done

Page 1 pins a snapshot for stateful actions (events, telemetry). If the session expires (~30 min) the API returns action_value="3" with description pagination_session_expired — restart from page_number=1.

Notes

Legacy returns the full roster in one response (~thousands of rows); the new API paginates. The roster is mostly inactive/placeholder drivers, so many rows legitimately have empty work/vehicle/contact fields. last_event_* are populated only for drivers with recent ignition-filtered telemetry; driver_main_vehicle_* are sparsely populated in the source data.

Request

curl

curl -X POST 'https://private.stage.questar.io/v2/private-questar-units/api' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  --data '{"action":{"name":"get_user_drivers_rep","parameters":[{"active_drivers":2,"driver_id":479149,"group_id":36536}]}}'

Body

{
  "action": {
    "name": "get_user_drivers_rep",
    "parameters": [
      {
        "active_drivers": 2,
        "driver_id": 479149,
        "group_id": 36536
      }
    ]
  }
}

Response

Successful responses always wrap the action's payload in response.properties. The action_value field reports the handler outcome: "0" for success, "1" for invalid params, "2" for not allowed, "3" for limit-exceeded /pagination-session-expired, "999" for general error.

200 OK