Purpose: Use this endpoint to view a list of all the events and its details that happen on a regular basis. This endpoint will tell you when the driver was ON DUTY, and when the driver was OFF DUTY, with details such as the location, status, and time.

📘

NOTE

The difference between the start_date and the end-date must not be more than 3 months.

Response Parameters

id

• Type: Integer
• Description: The unique identifier of the event.

time

• Type: String (DateTime)
• Description: The timestamp when the event occurred.

type

• Type: String
• Description: The type of event (e.g., on_duty).

city

• Type: String
• Description: The city where the event took place (if available).

state

• Type: String
• Description: The state where the event took place (if available).

notes

• Type: String
• Description: Any additional notes associated with the event.

location

• Type: String
• Description: The specific location of the event.

origin

• Type: String
• Description: The source of the event (e.g., api).

created_at

• Type: String (DateTime)
• Description: The timestamp when the event was created.

updated_at

• Type: String (DateTime)
• Description: The timestamp when the event was last updated.

driver

• Type: Object
• Description: Contains details about the driver associated with the event.

id

• Type: Integer
• Description: The unique identifier of the driver.

first_name

• Type: String
• Description: The first name of the driver.

last_name

• Type: String
• Description: The last name of the driver.

username

• Type: String
• Description: The username of the driver.

email

• Type: String
• Description: The email address of the driver.

driver_company_id

• Type: Integer
• Description: The company ID associated with the driver or the user. (if applicable).

status

• Type: String
• Description: The current status of the user (e.g., active).

role

• Type: String
• Description: The role of the user (e.g., driver).