Skip to main content
GET
Dispatcher Board List

Authorizations

Authorization
string
header
default:Token <api-key>
required

Send your API key with the Token prefix: Authorization: Token <api-key>.

Query Parameters

start_date
string<date>
required

Start of the date window, inclusive. Use the format YYYY-MM-DD. Trips count by pickup or delivery date, per the company payroll setting.

Example:

"2026-08-01"

end_date
string<date>
required

End of the date window, inclusive. Use the format YYYY-MM-DD.

Example:

"2026-08-31"

page
integer

Page number for paginated results.

Required range: x >= 1
Example:

1

page_size

Results per page. Default: 10. Use a positive integer, or all for every result on one page. No maximum.

Required range: x >= 1
Example:

10

Response

List of dispatcher board retrieved successfully

count
integer
required

Total number of dispatcher board entries.

next
string | null
required

URL to the next page of results.

previous
string | null
required

URL to the previous page of results.

results
object[]
required

List of dispatcher board entries.