Retrieves a list of locations
Security
The requesting user must have the following permission to retrieve locations:
- Administration → Locations → View Locations
Location access: location access is separate from permissions — the endpoint returns data only for locations assigned to the requesting API user. A user with the correct permission but no assigned locations receives no records.
Identifies the R365 tenant the request applies to. Required on every request.
Starting datetime of the 'modifiedOn' range (inclusive). May be supplied alone, in which case the range is open-ended at the upper bound.
Ending datetime of the 'modifiedOn' range (inclusive). May be supplied alone, in which case the range is open-ended at the lower bound.
Filter by location number. Accepts a comma-separated list, e.g. 314,3030.
Maximum number of top-level objects to return in one page.
Continuation token for pagination. Use the nextLink value from a previous response to fetch the next page.
list of location entities
Paginated response containing locations.
Locations for the current page.
A location.
Unique identifier of the location.
Display name of the location.
Location number.
Windows time-zone identifier for the location, e.g. "Pacific Standard Time".
Addresses for the location.
A location address.
State or province code.
URL of the next page, or null on the last page.
Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range.
Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant.
Forbidden — the caller lacks the permission required for this operation.
Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired.
Conflict — the request conflicts with the current state of the resource and cannot be applied.
Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid.
Too Many Requests — the caller has exceeded the rate limit; retry after a short delay.
Internal Server Error — an unexpected error occurred while processing the request.