Headers

• X-Gatego-oid

  Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Query parameters

• exactName string

  Searches drivers whose name is equal to the value specified (exact search)

• filter string

  Searches drivers by name containing the value specified (wildcard search)

• truckNumber string

  Searches drivers whose trucknumber contains the value specified (wildcard search)

Responses

• 200 */*

  OK

  Hide response attributes Show response attributes object

  • account object
    Hide account attributes Show account attributes object

    • active boolean
    • can_view_carrier_ids array[integer(int64)]
    • can_view_other_carriers boolean
    • carrier_id integer(int64)
    • deleted_at string(date-time)
    • driver object
      Hide driver attributes Show driver attributes object

      • license string
      • license_expiration string(date-time)
      • license_picture_id string
      • photo_id string
      • safety_card_picture_id string
      • truck_number string
    • driver_license string
    • driver_license_expiration string(date-time)
    • driver_license_picture_id integer(int64)
    • driver_photo_id integer(int64)
    • driver_safety_card_picture_id integer(int64)
    • driver_truck_number string
    • email string
    • email_confirmed boolean

      Whether user has confirmed his email address

    • hmac string

      HMAC-SHA256 of the user id

    • hmac_android string
    • hmac_ios string
    • id integer(int64)
    • language_code string
    • last_login string(date-time)
    • last_login_app_version string
    • last_login_referer string
    • managed_organization_group object
      Hide managed_organization_group attributes Show managed_organization_group attributes object

      • id integer(int64)
      • managed_organizations array[object]
        Hide managed_organizations attributes Show managed_organizations attributes object

        • id integer(int64)
        • name string
      • name string
    • name string
    • organization object
      Hide organization attributes Show organization attributes object

      • id integer(int64)
      • name string
    • phone_number string
    • previous_last_login string(date-time)
    • role string

      Values are ADMIN, CARRIER_ADMIN, DRIVER, GUARD, ORG_ADMIN, ORG_GROUP_ADMIN, RESTRICTED_GUARD, SIGNUP_SERVICE, SUPER_CARRIER_ADMIN, YARD_ADMIN, or YARD_DRIVER.

    • username string
    • yard_id integer(int64)
  • active boolean
  • carrier object
    Hide carrier attributes Show carrier attributes object

    • address string
    • address_additional_info string
    • authorized boolean
    • created_at string(date-time)
    • created_by string
    • email string
    • fleet_id string
    • id integer(int64)
    • last_modified_at string(date-time)
    • last_modified_by string
    • name string
    • rfc string
    • scac string
    • usdot string
    • yards array[object]
      Hide yards attributes Show yards attributes object

      • authorized boolean
      • carrier_capacity integer(int64)
      • yard_id integer(int64)
  • created_at string(date-time)
  • id integer(int64)
  • last_modified_at string(date-time)
  • license string
  • license_expiration string(date-time)
  • license_picture object
    Hide license_picture attributes Show license_picture attributes object

    • id integer(int64)
    • name string
    • type string

      Values are BILL_OF_LADING_PHOTO, DRIVER_LICENSE_PHOTO, DRIVER_PHOTO, DRIVER_SAFETY_CARD_PHOTO, EXTRA_FILE, GUEST_VEHICLE_PHOTO, LICENSE_PLATE_PHOTO, REAR_TRAILER_PHOTO, TIRE_PHOTO, TRAILER_INSIDE_PHOTO, TRAILER_ISSUE_PHOTO, TRAILER_LEFT_PHOTO, TRAILER_RIGHT_PHOTO, TRAILER_SEAL_PHOTO, TRUCK_CARRIER_INFO_PHOTO, TRUCK_ISSUE_PHOTO, TRUCK_PHOTO, VISITOR_PERSON_PHOTO, or WASH_OUT_SLIP_PHOTO.

    • url string
  • license_picture_id integer(int64)
  • name string
  • organization_id integer(int64)
  • photo_id integer(int64)
  • safety_card_picture_id integer(int64)
  • truck_carrier object
    Hide truck_carrier attributes Show truck_carrier attributes object

    • address string
    • address_additional_info string
    • authorized boolean
    • created_at string(date-time)
    • created_by string
    • email string
    • fleet_id string
    • id integer(int64)
    • last_modified_at string(date-time)
    • last_modified_by string
    • name string
    • rfc string
    • scac string
    • usdot string
  • truck_id integer(int64)
  • truck_number string
• 401

  Unauthorized

• 403

  Forbidden

• 404

  Not Found