Documentation :: AllTruckJobs.com

AllTruckJobs API v2.0

Drivers

The drivers resource is used to manage application data submitted by drivers on AllTruckJobs.

List all drivers

GET https://qa-sit.alltruckjobs.com/api/v2.0/drivers.json GET https://qa-sit.alltruckjobs.com/api/v2.0/drivers.xml

URL Parameters

No parameters.

Query Parameters

certifications optional enum

Fetch only drivers with the specified endorsements.

Possible enum values:
  • Doubles/Triples (T)
  • HAZMAT (H)
  • Tank Vehicles (N)
  • Tanker + HAZMAT (X)

driver_type optional enum

Fetch only drivers with the specified driver type.

Possible enum values:
  • Owner Operator
  • Company Driver
  • Student

email optional email

Fetch only drivers with the specified email address.

end_date optional date-time

Fetch only drivers who submitted their application to your company before the specified date or date/time.

first_name optional string

Fetch only drivers with the specified first name.

has_job_apps optional boolean

Fetch only drivers who have (1) or have not (0) applied to one of your jobs.

job_title optional string

Fetch only drivers who applied to a job of the specified title.

last_name optional string

Fetch only drivers with the specified last name.

lives_within_radius optional integer

Fetch only drivers who live within the specified radius (in miles) of the location provided in lives_within_zip.

lives_within_zip optional string

Fetch only drivers who live within the radius (in miles) provided in lives_within_radius of the specified location.

max optional integer

Maximum number of drivers to return.

min_experience optional enum

Fetch only drivers with at least the specified minimum experience.

Possible enum values:
  • 0
  • 0.5
  • 1
  • 1.5
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99

phone optional phone

Fetch only drivers with the specified phone number.

sort optional enum

Sort by the specified field. Defaults to ascending order; for descending order, put a - (hyphen) in front of the field name.

For example: -sent would sort the drivers in descending order based on the date/time they submitted their application to your company.

Possible enum values:
  • id
  • name
  • state
  • driver_type
  • sent

start_date optional date-time

Fetch only drivers who submitted their application to your company after the specified date or date/time.

state optional enum

Fetch only drivers who reside in the specified state.

Possible enum values:
  • AL
  • AK
  • AZ
  • AR
  • CA
  • CO
  • CT
  • DE
  • FL
  • GA
  • HI
  • ID
  • IL
  • IN
  • IA
  • KS
  • KY
  • LA
  • ME
  • MD
  • MA
  • MI
  • MN
  • MS
  • MO
  • MT
  • NE
  • NV
  • NH
  • NJ
  • NM
  • NY
  • NC
  • ND
  • OH
  • OK
  • OR
  • PA
  • RI
  • SC
  • SD
  • TN
  • TX
  • UT
  • VT
  • VA
  • WA
  • DC
  • WV
  • WI
  • WY

Example Request

GET https://qa-sit.alltruckjobs.com/api/v2.0/drivers.json GET https://qa-sit.alltruckjobs.com/api/v2.0/drivers.xml

Example Response

[
    {
        "id": 12345,
        "first_name": "John",
        "last_name": "Doe",
        "address": "1234 Example Street",
        "address2": "Suite 5678",
        "city": "Louisville",
        "state": "KY",
        "zip": "40210",
        "email": "johndoe@test.com",
        "phone": "1234567890",
        "driver_type": "Owner Operator",
        "experience": "1",
        "sent": "2015-12-08T15:24:35-05:00",
        "has_job_apps": true
    },
    {
        "id": 67890,
        "first_name": "Jane",
        "last_name": "Smith",
        "address": "1234 Example Street",
        "address2": "Suite 5678",
        "city": "Lexington",
        "state": "KY",
        "zip": "40503",
        "email": "janesmith@test.com",
        "phone": "1234657890",
        "driver_type": "Owner Operator",
        "experience": "37",
        "sent": "2015-12-08T15:24:35-05:00",
        "has_job_apps": false
    }
]
<?xml version="1.0"?>
<drivers>
  <driver>
    <id>12345</id>
    <first_name>John</first_name>
    <last_name>Doe</last_name>
    <address>1234 Example Street</address>
    <address2>Suite 5678</address2>
    <city>Louisville</city>
    <state>KY</state>
    <zip>40210</zip>
    <email>johndoe@test.com</email>
    <phone>1234567890</phone>
    <driver_type>Company Driver</driver_type>
    <experience>67</experience>
    <sent>2015-12-08T15:24:35-05:00</sent>
    <has_job_apps>1</has_job_apps>
  </driver>
  <driver>
    <id>67890</id>
    <first_name>Jane</first_name>
    <last_name>Smith</last_name>
    <address>1234 Example Street</address>
    <address2>Suite 5678</address2>
    <city>Lexington</city>
    <state>KY</state>
    <zip>40503</zip>
    <email>janesmith@test.com</email>
    <phone>1234657890</phone>
    <driver_type>Student</driver_type>
    <experience>17</experience>
    <sent>2015-12-08T15:24:35-05:00</sent>
    <has_job_apps></has_job_apps>
  </driver>
</drivers>

Retrieve a Driver

GET https://qa-sit.alltruckjobs.com/api/v2.0/drivers.json/:id GET https://qa-sit.alltruckjobs.com/api/v2.0/drivers.xml/:id

URL Parameters

id REQUIRED integer

The ID number of the driver you want to fetch.

Query Parameters

No parameters.

Example Request

GET https://qa-sit.alltruckjobs.com/api/v2.0/drivers.json/12345 GET https://qa-sit.alltruckjobs.com/api/v2.0/drivers.xml/12345

Example Response

{
    "id": 12345,
    "first_name": "John",
    "last_name": "Doe",
    "address": "1234 Example Street",
    "address2": null,
    "city": "Louisville",
    "state": "KY",
    "zip": "40210",
    "sent": "2015-12-08T15:24:35-05:00",
    "email": "johndoe@test.com",
    "phone": "+1234567890",
    "driver_type": "Student",
    "experience": "66",
    "endorsement": "HAZMAT (H)",
    "freight_experience": "Dry Bulk",
    "freight_preferences": "Box",
    "license_state": "Arkansas",
    "preferred_assignments": "LTL",
    "preferred_regions": "Southeast",
    "has_team": "",
    "license_class": "Class B",
    "date_of_birth": "06/16/1965",
    "twic_card": "Yes",
    "accidents": "1",
    "moving_violations": "1",
    "last_license_suspension": 2020,
    "last_dui": 2017,
    "interested_lease_purchase": "Yes",
    "teams": "Team",
    "trucks_owned": "",
    "employment_history": [
        {
            "company": "Example Company",
            "state": "PA",
            "phone": "1234567890",
            "start_date": "2021-01-01",
            "end_date": null
        }
    ],
    "job_applications": [
        {
            "job_id": 21237,
            "title": "Example Job Title",
            "reference": "EXAMPLE12356",
            "is_direct_app": true,
            "created_at": "1963-07-08T07:29:23+00:00"
        }
    ],
    "is_premium": true
}
<?xml version="1.0"?>
<drivers>
  <driver>
    <id>12345</id>
    <first_name>John</first_name>
    <last_name>Doe</last_name>
    <address>1234 Example Street</address>
    <address2></address2>
    <city>Louisville</city>
    <state>KY</state>
    <zip>40210</zip>
    <sent>2015-12-08T15:24:35-05:00</sent>
    <email>johndoe@test.com</email>
    <phone>+1234567890</phone>
    <driver_type>Owner Operator</driver_type>
    <experience>54</experience>
    <endorsement>Tanker + HAZMAT (X)</endorsement>
    <freight_experience>Dry Bulk</freight_experience>
    <freight_preferences>Yard Spotter</freight_preferences>
    <license_state>Washington</license_state>
    <preferred_assignments>OTR</preferred_assignments>
    <preferred_regions>Southwest</preferred_regions>
    <has_team></has_team>
    <license_class>Class C</license_class>
    <date_of_birth>10/02/1960</date_of_birth>
    <twic_card>Yes</twic_card>
    <accidents>7</accidents>
    <moving_violations>1</moving_violations>
    <last_license_suspension>2024</last_license_suspension>
    <last_dui>2021</last_dui>
    <interested_lease_purchase>Yes</interested_lease_purchase>
    <teams>Both</teams>
    <trucks_owned></trucks_owned>
    <employment_history>
      <company>Example Company</company>
      <state>PA</state>
      <phone>1234567890</phone>
      <start_date>2021-01-01</start_date>
      <end_date></end_date>
    </employment_history>
    <job_applications>
      <job_id>55650</job_id>
      <title>Example Job Title</title>
      <reference>EXAMPLE12356</reference>
      <is_direct_app></is_direct_app>
      <created_at>1993-04-29T12:44:02+00:00</created_at>
    </job_applications>
    <is_premium></is_premium>
  </driver>
</drivers>