External API
Docs & Playground
Drivers/api_get_drivers

api_get_driverstoken required

Legacy driver list. Not implemented on this platform — use `get_user_drivers`, which returns the same driver data under the same field names.

Try in playground
POST/api— body field action.name = "api_get_drivers"

Parameters

This action takes no parameters.

Notes

This action exists on the legacy API only; calling it here returns an unknown-action error. `get_user_drivers` is the replacement and shares 24 of its 26 fields by name and meaning. The two legacy-only fields do not need porting: `object_id` is the row's position in the page (1, 2, 3 …) feeding the legacy `last_object_id` cursor, and `user_name` is returned by legacy but empty in every row observed. `get_user_drivers` adds `last_event_direction`. Two things to change when migrating: page with `page_number` / `page_size` and iterate on `pagination.has_more` instead of advancing `last_object_id`, and treat the fields listed in the `get_user_drivers` notes as optional — several are not yet populated on this platform.

Request

curl
curl -X POST 'https://private.develop-1.questar.io/v2/private-questar-units/api' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  --data '{"action":{"name":"api_get_drivers","parameters":[]}}'
Body
{
  "action": {
    "name": "api_get_drivers",
    "parameters": []
  }
}

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.

Authentication is checked before the action runs and fails the same way for every action. A token that is not valid returns HTTP 200 with action_value "2" and description invalid_session; an empty bearer returns "2" with session_token_required. Read the description to tell these apart from an action's own "2". With no Authorization header the gateway answers HTTP 401 {"message":"Unauthorized"}, and with a bearer that is not a token HTTP 403 {"message":"Forbidden"}.

200 OK
{
  "response": {
    "properties": {
      "action_name": "api_get_drivers",
      "action_value": "0",
      "description": "success",
      "data": [
        {}
      ]
    }
  }
}