v1

latestOpenAPI 3.0.12026-07-2487135176.5 KB
Locations

List Locations

List all locations within the specified account.

get/public/v3/Locations

Query parameters

Namestring

Filter results by the name of the saved location.

LoadTiveProvidedLocationsboolean

Load tive provided locations such as airports and seaports

OnlySavedLocationsboolean

Filter the results to include only saved locations. Defaults to false if not provided.

PageSizeinteger

The number of results to retrieve. Default and maximum is 50.

PageNumberinteger

The page number to use. This is needed when there are more objects than the max page size. The default is 1.

Headers

x-tive-account-idinteger required

ID of the account the request will be made in.

Response

The requested locations

totalRecordsinteger
pageNumberinteger
pageSizeinteger
nextstring nullable
previousstring nullable