locations_get_list
Retrieve a filtered list of customer locations by specifying parameters such as city, state, zip, or creation/modification dates. Supports sorting, pagination, and external data lookups.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
active | No | What kind of items should be returned (only active items will be returned by default) Values: [True, Any, False] | |
city | No | Filters by customer's city | |
country | No | Filters by customer's country | |
createdBefore | No | Format - date-time (as date-time in RFC3339). Return items created before certain date/time (in UTC) | |
createdOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items created on or after certain date/time (in UTC) | |
customerId | No | Format - int64. Filters by customer ID | |
externalDataApplicationGuid | No | Format - guid. Returns location records with external data for a particular GUID | |
externalDataKey | No | Performs lookup by external data key, 'externalDataValues' must also be provided. | |
externalDataValues | No | Performs lookup by external data values (maximum 50), 'externalDataKey' must also be provided. | |
ids | No | Perform lookup by multiple IDs (maximum 50) | |
includeTotal | No | Whether total count should be returned | |
latitude | No | Format - double. Filters by customer's latitude | |
longitude | No | Format - double. Filters by customer's longitude | |
modifiedBefore | No | Format - date-time (as date-time in RFC3339). Return items modified before certain date/time (in UTC) | |
modifiedOnOrAfter | No | Format - date-time (as date-time in RFC3339). Return items modified on or after certain date/time (in UTC) | |
name | No | Filters by customer's name | |
page | No | Format - int32. The logical number of page to return, starting from 1 | |
pageSize | No | Format - int32. How many records to return (50 by default) | |
sort | No | Applies sorting by the specified field: "?sort=+FieldName" for ascending order, "?sort=-FieldName" for descending order. Available fields are: Id, ModifiedOn, CreatedOn. | |
state | No | Filters by customer's state | |
street | No | Filters by customer's street | |
tenant | Yes | Format - int64. Tenant ID | |
unit | No | Filters by customer's unit | |
zip | No | Filters by customer's zip |