Customers

About the Customer API

The EverTransit Customer API allows you to create a new customer, list customers from a given email, and retrieve the details of a particular customer by its ID. To make your requests, you can use the endpoints and their methods listed below.

Endpoints

• Create a customer

• List customers

• Retrieve a customer

The Customer object

{
   "id": "5f886c22fe5dd800318f8092",
   "firstName": "John",
   "lastName": "Doe",
   "email": "[email protected]",
   "phoneNumber": "[phone]",
   "createdTime": "2022-08-18T01:10:16.000Z",
}

Attributes

Name	Type	Description
firstName	string	The first name of the customer.
lastName	string	The last name of the customer.
email	string	The email of the customer.
id	string	A unique identifier for the customer.
phoneNumber	string	The phone number of the customer.
createdTime	string	The date and time the customer was created in ISO format.
hits	array	Information about the ride that matches the search criteria. For example, the ID, passengers, status, destination, service level, rider, driver, etc.
totalHits	number	The number of matching criteria from the search result.

Create a customer

Create a customer.

post

Create a customer.

Authorizations

ApiKeyAuth

apikeystringRequired

Body

application/json

emailstring · emailRequired

The email of the customer.

Example: [email protected]

firstNamestringRequired

The first name of the customer.

Example: John

lastNamestringRequired

The last name of the customer.

Example: Doe

phoneNumberstringRequired

The phone number of the customer.

Example: [phone]

Responses

200

The customer was created successfully.

application/json

idstringOptional

A unique identifier for the customer.

Example: 5f886c22fe5dd800318f809j

emailstring · emailOptional

The email of the customer.

Example: [email protected]

firstNamestringOptional

The first name of the customer.

Example: John

lastNamestringOptional

The last name of the customer.

Example: Doe

phoneNumberstringOptional

The phone number of the customer.

Example: [phone]

createdTimestring · date-timeOptional

The date and time the customer was created in ISO format.

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

400

Bad request.

application/json

401

Unauthorized.

application/json

post

/customers

HTTPcURLJavaScriptPython

POST /v2beta/customers HTTP/1.1
Host: endpoints.evertransit.com
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "[phone]"
}

{
  "id": "5f886c22fe5dd800318f809j",
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "[phone]",
  "createdTime": "2022-08-16T22:06:24.024Z"
}

API playground for creating a customer

List customers

List customers.

get

Retrieves a list of customers that matches the criteria.

Authorizations

ApiKeyAuth

apikeystringRequired

Query parameters

emailstring · emailOptional

Only customers with this email will be returned.

Example: [email protected]

limitinteger · int32 · min: 1Optional

The limit of items per page in the response.

Default: 20Example: 10

pageinteger · int32 · min: 1Optional

Specify the page to retrieve. You will need to use it if you want to retrieve specific pages.

Default: 1Example: 1

Responses

200

Results that match the criteria.

application/json

totalHitsintegerOptional

The number of matching criteria from the result.

Example: 1

400

Bad request.

application/json

401

Unauthorized.

application/json

get

/customers

HTTPcURLJavaScriptPython

GET /v2beta/customers HTTP/1.1
Host: endpoints.evertransit.com
Accept: */*

{
  "hits": [
    {
      "id": "5f886c22fe5dd800318f809j",
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Doe",
      "phoneNumber": "[phone]",
      "createdTime": "2022-08-16T22:06:24.024Z"
    }
  ],
  "totalHits": 1
}

API playground for listing customers

Retrieve a customer

Retrieve a customer.

get

Retrieve a customer by its ID.

Authorizations

ApiKeyAuth

apikeystringRequired

Path parameters

customerIdstringRequired

A unique identifier for the customer.

Example: 507f191e810c19729de860jk

Responses

200

The customer was retrieved successfully.

application/json

idstringOptional

A unique identifier for the customer.

Example: 5f886c22fe5dd800318f809j

emailstring · emailOptional

The email of the customer.

Example: [email protected]

firstNamestringOptional

The first name of the customer.

Example: John

lastNamestringOptional

The last name of the customer.

Example: Doe

phoneNumberstringOptional

The phone number of the customer.

Example: [phone]

createdTimestring · date-timeOptional

The date and time the customer was created in ISO format.

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

401

Unauthorized.

application/json

404

Not found.

application/json

get

/customers/{customerId}

HTTPcURLJavaScriptPython

GET /v2beta/customers/{customerId} HTTP/1.1
Host: endpoints.evertransit.com
Accept: */*

{
  "id": "5f886c22fe5dd800318f809j",
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "[phone]",
  "createdTime": "2022-08-16T22:06:24.024Z"
}

API playground for retrieving a customer