Find Addresses by query string.
Authentication
Standard HTTP Bearer token. Enter the 'access_token' value.
Header Parameters
This API is protected under OAuth 2 with the client_credentials grant flow and requires an API client_id and client_secret.
The client_id and client_secret are provisioned by the Fleet Services team.
Access Tokens have a lifespan of 15 minutes.
Requesting an access token
Parameters:
- client_id = my-client-id
- client_secret = my-client-secret
- [base-url] = Replace with the correct server URL for the environment you are using (e.g. - https://wmd.xc.wexonl...
Query Parameters
A Lucene-style search query
If a query returns multiple pages (total records/size) you can use this value to select a specific page to return. Defaults to zero.
Number of records per page.
Sorting criteria in the format: non-analysed field name (i.e. "state.keyword") + direction (asc / desc) Default sort order is ascending.
Response
Addresses matching the search criteria
Response Attributes
Show child attributes
Show child attributes
Warning or informational note about the response if any.
Show child attributes
Total number of items.
400 (Bad Request)
Response Attributes
401 (Unauthorized)
Response Attributes
403 (Forbidden)
Response Attributes
500 (Internal Server Error)
Response Attributes
Response