Drivers

About the Driver API

The EverTransit Driver API allows you to create an invitation for a driver to your fleet. To make your request, you can use the endpoint and method listed below.

Endpoints

• Create a driver invitation

The Driver invitation object

{
  "email": "[email protected]",
  "id": "5f886c22fe5dd800318f809f",
  "status": "pending",
  "createdTime": "2022-08-16T22:06:24.024Z"
}

Attributes

Name	Type	Description
email	string	The email of the driver.
id	string	A unique identifier for the driver invitation.
status	string	The status of the invitation request.
createdTime	string	The date and time the driver invitation request was created in ISO format.

Create a Driver invitation

Create a driver invitation.

post

You can use this endpoint to invite a driver to your fleet. The driver must be registered in the EverTransit driver application: https://apps.apple.com/us/app/evertransit/id1611567689.

Authorizations

ApiKeyAuth

apikeystringRequired

Body

application/json

emailstring · emailRequired

The email of the driver which you want to invite.

Example: [email protected]

Responses

200

The driver invitation was created successfully.

application/json

emailstring · emailRequired

The email of the driver which you want to invite.

Example: [email protected]

idstringRequired

The Id of the driver invitation.

Example: 5f886c22fe5dd800318f809f

statusstring · enumRequired

The status of the driver invitation.

Possible values:

createdTimestring · date-timeRequired

The date and time when the driver invitation was created. It is in ISO format

Example: 2022-08-16T22:06:24.024Z

400

Bad request.

application/json

401

Unauthorized.

application/json

post

/drivers/invitations

HTTPcURLJavaScriptPython

POST /v2beta/drivers/invitations HTTP/1.1
Host: endpoints.evertransit.com
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "email": "[email protected]"
}

{
  "email": "[email protected]",
  "id": "5f886c22fe5dd800318f809f",
  "status": "pending",
  "createdTime": "2022-08-16T22:06:24.024Z"
}

API playground for creating a driver invitation