List tasks

GET/app/v1/task/

Read and write tasks.

Unlike every other public endpoint this one accepts writes, because a task is something a person asks for rather than a record of something that already happened.

A company API key is not a person, so created_by must name the team member the task is being raised for. The activity log records the key's name alongside it, so both halves are visible: who asked, and what made the call.

Authorization

X-API-KEYstring · headerrequired

Your company's API key.

Query parameters

assigned_tointeger

Team member id.

created_byinteger

Team member id who raised the task.

driver_recordinteger

Team member id the task is about.

due_beforestring

Only tasks due on or before this date (YYYY-MM-DD).

modelstring

Driver, Vehicle, Trailer, Company or -.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

Free text across title, description, the driver the task is about, and the unit.

statusstring

Open or Completed. Comma-separate for several.

unit_nostring

Unit the task is about. Comma-separate for several.

Response

200A page of records in data
idinteger
created_byobject
Show fields
idinteger
namestring
assigned_toobject
Show fields
idinteger
namestring
driver_recordobject
Show fields
idinteger
namestring
equipment_recordobject
Show fields
idinteger
unit_nostring
typeenum

One of: Vehicle Trailer

record_namestring
titlestring
descriptionstring
add_datestring (date)
due_datestring (date)
statusenum

One of: Open Completed

modelenum

One of: - Driver Vehicle Trailer Company

created_atstring (date-time)
updated_atstring (date-time)