Driver Schedule API Developer Documentation

To enable API access from another program, you'll need to use an "Access Token". The API (Application Programming Interface) allows the other program to communicate with your DriverSchedule.com account.

Go to Company Settings -> API and Generate an "Access Token"

HTTP Response Status Code:
Always expect a 200 response status code, even when errors get returned.
Example error:


{
  "status": "error",
  "message": "Invalid Request (401)"
}

Get Driver Availability:

https://www.driverschedule.com/api/v2/schedule

Parameters

startdate: required - ex: "2/17/2025" or "2025-02-17T00:00:00"
enddate: optional - ex: "2/23/2025" or "2025-02-23T00:00:00"
driverid: optional - employee number on driver record in driver schedule


curl --request GET \
	--url https://www.driverschedule.com/api/v2/schedule \
	--header 'accesstoken: [access_token]' \
	--data 'startdate=2025-02-17T00:00:00&enddate=2025-02-24T00:00:00'

JSON response:

{
	"status": "success" or "error",
	"message": string - empty if status is success, otherwise this will be the error message,
	"driver": [
		{
			"id": string (employee number on driver record in driver schedule),
			"firstname": string,
			"lastname": string,
			"time": [
				{
				"start": datetime,
				"end": datetime,
				"shiftId": int (driver scheduled generated id. may be null),
				"shiftName": string (name of shift in driver schedule. may be null),
				"timeZone": string (name of timezone associted with the location in driver schedule. may be null) ex: "(UTC-05:00) Eastern Time (US & Canada)"
				}
			]
		}
	]
}

Update Driver Availability:

https://www.driverschedule.com/api/v2/schedule


curl --request POST \
	--url https://www.driverschedule.com/api/v2/schedule \
	--header 'accesstoken: [access_token]' \
	--header 'Content-Type: application/json' \
	--data '[JSON data]' \

Sample JSON Body:


{
	"startDate": "2025-02-17T00:00:00", (required)
	"endDate": "2025-02-24T00:00:00", (required)
	"driver": [
		{
			"id": "123456", (employee number on driver record in driver schedule - required)
			"time": [
				{
					"start": "2025-02-17T08:00:00",
					"end": "2025-02-17T20:00:00",
					"shiftId": 8 (driver scheduled generated id. optional)
				}
			]
		}
	]
}

Get Shift Schedule Capacity:

https://www.driverschedule.com/api/v2/shiftschedulecapacity

Parameters

startdate: required - ex: "2/17/2025" or "2025-02-17T00:00:00"
enddate: required - ex: "2/23/2025" or "2025-02-23T00:00:00"


curl --request GET \
	--url https://www.driverschedule.com/api/v2/shiftschedulecapacity \
	--header 'accesstoken: [access_token]' \
	--data 'startdate=2025-02-17T00:00:00&enddate=2025-02-24T00:00:00'

JSON response:


{
  "status": "success",
  "message": "",
  "locations": [
    {
      "id": 1,
      "name": "Hartford & New Haven",
      "shifts": [
        {
          "id": 2,
          "name": "All Hours",
          "dates": [
            {
              "date": "2022-08-01T00:00:00",
              "categoryId": 9,
              "categoryName": "Category 1",
              "capacity": 10,
              "taken": 8
            },
            {
              "date": "2022-08-01T00:00:00",
              "categoryId": 11,
              "categoryName": "Category 2",
              "capacity": 1,
              "taken": 0
            },
            {
              "date": "2022-08-01T00:00:00",
              "categoryId": 10,
              "categoryName": "Category 3",
              "capacity": 0,
              "taken": 0
            },
            {
              "date": "2022-08-01T00:00:00",
              "categoryId": 12,
              "categoryName": "Category 4",
              "capacity": 0,
              "taken": 0
            }
          ]
        }
      ]
    }
  ]
}

Get Appointments:

https://www.driverschedule.com/api/v2/appointments

Parameters

startdate: required - ex: "2/17/2025" or "2025-02-17T00:00:00"
enddate: optional - ex: "2/23/2025" or "2025-02-23T00:00:00"


curl --request GET \
	--url https://www.driverschedule.com/api/v2/appointments \
	--header 'accesstoken: [access_token]' \
	--data 'startdate=2025-02-17T00:00:00&enddate=2025-02-24T00:00:00'

JSON response:


{
  "status": "success",
  "message": "",
  "appointments": [
    {
      "id": 49361,
      "title": "",
      "startdate": "2020-12-23T07:00:00",
      "enddate": "2020-12-23T15:00:00",
      "notes": "",
      "staffNotes": "",
      "originAddress": "4800 E 7th St Austin, TX 78702",
      "status": "Incomplete",
      "type": "Road Test - Auto Fleet",
      "reportTime": 30,
      "dwellTime": 12,
      "blockTime": 12,
      "duration": 480,
      "createDate": "2020-12-23T07:00:00",
      "createdByUser": "Michael Lindsey",
      "modifiedDate": "2020-12-23T07:00:00",
      "modifiedByUser": "Michael Lindsey",
      "stops": [
        {
          "address": "1098 North Colony Road Wallingford, CT 06492",
          "arrivalTime": "2019-09-27T11:00:00",
          "estimatedArrivalTime": "2019-09-27T11:00:00",
          "duration": 75,
          "description": "",
          "notes": "",
          "phone": "555-555-5555",
          "driverNotes": "",
          "price": 59.99,
          "allowPhotos": true,
          "requireSignature": false,
          "checklist": "name of checklist",
          "customer": {
            "firstName": "",
            "lastName": "",
            "company": "Chick-fil-A",
            "email": "info@driverschedule.com",
            "workPhone": "203-555-5555",
            "mobilePhone": "",
            "homePhone": "",
            "notes": ""
          }
        }
      ],
      "drivers": [
        {
          "firstName": "Freddy",
          "lastName": "Cerritos"
        },
        {
          "firstName": "Carlos",
          "lastName": "Renova"
        }
      ],
      "vehicles": [
        {
          "make": "FORD",
          "model": "VAN",
          "plateNumber": "",
          "color": "",
          "year": 2020,
          "id": "1234"
        }
      ]
    }
  ]
}