v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

List all the users of a company

get/v1/users

Query parameters

rolestring

Specify the role of the user whose information you are fetching. Possible values are: driver, fleet_user or admin.

duty_statusstring

Specify the status of the driver. Possible values are off_duty, on_duty, sleeper, driving, or waiting.

statusstring

Specify the status of the user. Possible values are active or deactivated.

namestring

Narrow down your filter for the search by entering the specific name of the individual whose details you want to see. You can enter either the first name, last name, or both.

updated_afterstring date

Specify the date on which the user was last updated. This filter will only return users who were updated after this specified date.

per_pageinteger

Number of records to return per page.

page_nointeger

Denotes the current page number.

Headers

X-Time-Zonestring

Specify the timezone for formatting the timestamps.

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

X-User-Idinteger

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Response

200

Example response

{
  "users": [
    {
      "user": {
        "id": 294979,
        "first_name": "John",
        "last_name": "Connor",
        "company_reference_id": "1",
        "time_zone": "Pacific Time (US & Canada)",
        "carrier_name": "Demo Carrier",
        "carrier_street": "415 Truckin St.",
        "carrier_city": "San Francisco",
        "carrier_state": "CA",
        "carrier_zip": "94105",
        "violation_alerts": "1_hour",
        "terminal_street": "350 Sansome St",
        "terminal_city": "San Francisco",
        "terminal_state": "CA",
        "terminal_zip": "94104",
        "export_combined": true,
        "export_recap": true,
        "export_odometers": true,
        "username": "demo_driver_1_kt3647454",
        "cycle": "70_8",
        "minute_logs": true,
        "duty_status": "off_duty",
        "eld_mode": "logs",
        "yard_moves_enabled": true,
        "personal_conveyance_enabled": true,
        "mobile_last_active_at": "2017-12-22T19:37:29Z",
        "web_last_active_at": "2017-11-19T20:48:57Z",
        "role": "driver",
        "status": "active",
        "created_at": "2016-08-09T00:43:40Z",
        "updated_at": "2017-03-30T01:06:13.169610Z",
        "external_ids": [
          {
            "external_id": "201",
            "integration_name": "generic_tms"
          }
        ]
      }
    }
  ],
  "pagination": {
    "per_page": 25,
    "page_no": 1,
    "total": 4
  }
}