Search

About the Search API

The EverTransit Search API allows you to search for rides and customers you have previously created. To make your requests, you can use the endpoints and their methods listed below.

Endpoints

• Search for rides

• Search for customers

The Ride Search object

{
  "hits": [
    {
      "id": "610058c5c594890018d2aa02",
      "scheduledTime": "2022-08-18T01:10:16.000Z",
      "pickup": {
        "address": "Orlando International Airport (MCO), USA"
      },
      "destination": {
        "address": "Tiffins Restaurant, Osceola Parkway, Orlando, FL, USA"
      },
      "service": {
        "name": "Test Payment July"
      },
      "rider": {
        "lastName": "Leon Bravo",
        "firstName": "Tahimi"
      },
      "driver": {
        "lastName": "Torres",
        "firstName": "Leandro"
      },
      "passengers": 1,
      "reservationNumber": "RES-713TE",
      "status": "completed",
      "externalId": null
    }
  ],
  "totalHits": 1,
  "totalPages": 1,
  "hitsPerPage": 1,
  "query": "RES-713TE"
}

Attributes

Name	Type	Description
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.
page	number	The page for which the data is retrieved.
totalPages	number	The total pages of the search result.
hitsPerPage	number	Set the number of hits per page.
query	string	The query that contains one or more search keywords and qualifiers.

Search for rides

Search for rides.

get

Returns a list of rides that matches the search criteria.

Authorizations

ApiKeyAuth

apikeystringRequired

Query parameters

querystringOptional

The query that contains one or more search keywords and qualifiers.

Default: ""Example: RES-713TE

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

Search results that match the criteria.

application/json

totalHitsintegerOptional

The number of matching criteria from the search result.

Example: 1

pageintegerOptional

The page for which the data is retrieved.

Example: 1

totalPagesintegerOptional

The total pages of the search result.

Example: 1

hitsPerPageintegerOptional

Set the number of hits per page.

Example: 1

querystringOptional

The query that contains one or more search keywords and qualifiers.

Example: RES-713TE

400

Bad request.

application/json

401

Unauthorized.

application/json

get

/search/rides

HTTPcURLJavaScriptPython

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

{
  "hits": [
    {
      "id": "5f886c22fe5dd800318f809j",
      "scheduledTime": "2022-08-16T22:06:24.024Z",
      "pickup": {
        "address": "Central Park, New York, NY, USA"
      },
      "destination": {
        "address": "Empire State Building, New York, NY, USA"
      },
      "service": {
        "name": "Limousine"
      },
      "rider": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "driver": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "passengers": 2,
      "reservationNumber": "RES-1QW2E3",
      "status": "scheduled",
      "externalId": "4251092660"
    }
  ],
  "totalHits": 1,
  "page": 1,
  "totalPages": 1,
  "hitsPerPage": 1,
  "query": "RES-713TE"
}

API playground for searching for rides

The Customer Search object

{
  "hits": [
    {
      "id": "629e9dfd0f1276444a9f75f8",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "phoneNumber": "[phone]",
      "createdTime": "2022-08-18T01:10:16.000Z"
    }
  ],
  "totalHits": 1,
  "totalPages": 1,
  "hitsPerPage": 20,
  "query": "John"
}

Attributes

Name	Type	Description
hits	array	Information about the customer that matches the search criteria. For example, the ID, first name, last name, email, phone number, and created time.
totalHits	number	The number of matching criteria from the search result.
totalPages	number	The total pages of the search result.
hitsPerPage	number	Set the number of hits per page.
query	string	The query that contains one or more search keywords and qualifiers.

Search for customers

Search for customers.

get

Retrieves a list of customers that matches the search criteria.

Authorizations

ApiKeyAuth

apikeystringRequired

Query parameters

querystringOptional

The query that contains one or more search keywords and qualifiers.

Default: ""Example: john

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

Search results that match the criteria.

application/json

totalHitsintegerOptional

The number of matching criteria from the search result.

Example: 1

pageintegerOptional

The page for which the data is retrieved.

Example: 1

totalPagesintegerOptional

The total pages of the search result.

Example: 1

hitsPerPageintegerOptional

Set the number of hits per page.

Example: 1

querystringOptional

The query that contains one or more search keywords and qualifiers.

Example: john

400

Bad request.

application/json

401

Unauthorized.

application/json

get

/search/customers

HTTPcURLJavaScriptPython

GET /v2beta/search/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,
  "page": 1,
  "totalPages": 1,
  "hitsPerPage": 1,
  "query": "john"
}

API playground for searching for customers