E
Exodus API
Docs & Playground
Admin/Lookup/get_user_drivers

get_user_driverstoken required

Returns drivers that the authenticated user is allowed to see, optionally filtered by driver or group id.

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

Parameters

NameTypeRequiredDescription
env_idnumberoptionalTenant environment id; defaults to the session env_id.e.g. 7
driver_idnumberoptionalDriver id (positive integer).e.g. 789
group_idnumberoptionalGroup id (positive integer).e.g. 10

Notes

Many enrichment fields (last_event_*, driver_cell_phone, etc.) are placeholders returned as empty strings until the underlying PG columns/views are added.

Request

curl
curl -X POST 'https://api.stage.questar.io/v2/exodus/api' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  --data '{"action":{"name":"get_user_drivers","parameters":[{"name":"env_id","value":7},{"name":"driver_id","value":789},{"name":"group_id","value":10}]}}'
Body
{
  "action": {
    "name": "get_user_drivers",
    "parameters": [
      {
        "name": "env_id",
        "value": "7"
      },
      {
        "name": "driver_id",
        "value": "789"
      },
      {
        "name": "group_id",
        "value": "10"
      }
    ]
  }
}

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, "999" for general error.

200 OK
{
  "response": {
    "properties": {
      "action_name": "get_user_drivers",
      "action_value": "0",
      "description": "success",
      "data": [
        {
          "driver_id": "789",
          "worker_id": "W-789",
          "driver_name": "John Doe",
          "active_flag": "",
          "driver_code": "",
          "client_group": "10",
          "group_name": "Tel Aviv Fleet",
          "parent_group": "",
          "parent_group_name": "",
          "driver_cell_phone": "",
          "customer_contact_person": "",
          "contact_person_phone_number": "",
          "driver_email": "",
          "last_event_id": "",
          "last_event_time": "",
          "last_event_type": "",
          "last_event_type_desc": "",
          "last_event_vehicle": "",
          "last_event_licence_number": "",
          "last_event_location": "",
          "last_event_latitude": "",
          "last_event_longitude": "",
          "last_event_direction": "",
          "driver_main_vehicle_id": "",
          "driver_main_vehicle_license_number": ""
        }
      ]
    }
  }
}