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
The Ride Search object
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.
Returns a list of rides that matches the search criteria.
Search results that match the criteria.
An array of objects with the information about the ride that matches the search criteria.
The number of matching criteria from the search result.
1
The page for which the data is retrieved.
1
The total pages of the search result.
1
Set the number of hits per page.
1
The query that contains one or more search keywords and qualifiers.
"RES-713TE"
API playground for searching for rides
The Customer Search object
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.
Retrieves a list of customers that matches the search criteria.
Search results that match the criteria.
An array of objects with the information about the customer that matches the search criteria.
The number of matching criteria from the search result.
1
The page for which the data is retrieved.
1
The total pages of the search result.
1
Set the number of hits per page.
1
The query that contains one or more search keywords and qualifiers.
"john"
Last updated