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": "[e-mail]",
  "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.

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.

POSThttps://endpoints.evertransit.com/v2beta/drivers/invitations

Body

application/json

The data to create the driver invitation.

email*string (email)

The email of the driver which you want to invite.

Example: "[e-mail]"

Response

200400401

The driver invitation was created successfully.

Body

application/json

email*string (email)

The email of the driver which you want to invite.

Example: "[e-mail]"

id*string

The Id of the driver invitation.

Example: "5f886c22fe5dd800318f809f"

status*enum

The status of the driver invitation.

pendingaccepted

createdTime*string (date-time)

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

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

Request

JavaScriptCurlPython

const response = await fetch('https://endpoints.evertransit.com/v2beta/drivers/invitations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]"
    }),
});
const data = await response.json();

Response

200400401

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

API playground for creating a driver invitation