Get a list of all locations for an organization
/api/v1/organizations/{orgShortName}/locations
{basePath}/organizations/tfoinc/locations
{basePath}/organizations/tfoinc/locations?offset=0&limit=2
The API returns a list of locations with which the integrator is privileged to interact within an organization.Request
- application/json
-
orgShortName(required): string
Organization Identifier
-
limit: integer
Minimum Value:
0The limit used for the current page.The maximum number of items to return in this request. -
offset: integer
Minimum Value:
0The offset of the start of the current page in the collection. If offset is not included in the request then all objects returned.
Response
- application/json
200 Response
objecttrue-
count:
integer
Total number of items in the collection for all pages
-
limit:
integer
The limit used for the current page
-
location(required):
array location
A collection of Locations
-
offset:
integer
The offset of the start of the current page in the collection
array-
Array of:
object Location
Title:
LocationA location represents the places of business within a customer's organization. A location can have one or more revenue centers.
objectLocation-
address:
object PostalAddress
Represents a postal address
-
consumerName:
string
consumer facing name
-
currency:
string
The currency of the location. Pricing displayed on menus from the location are in this currency, and all check operations are in this currency. Currency is presented inExample:
EUR -
extensions:
object ExtensionData
Additional Properties Allowed: additionalPropertiesContainer for extension data
-
geoLocation:
object GeoLocation
Coordinate of a location
-
languages:
array languages
Array of language culture reference strings configured for the location. First language listed is the default used if a request is made for an undefined language
-
locRef(required):
string
The location identifier.Example:
fdmnh144 -
name:
string
The location name.Example:
Fred Dome Stadium -
notes:
string
additional details
-
orgShortName(required):
string
The organization identifier.
-
phoneNumber:
string
Associated phone numberExample:
027410-22583 -
posPlatform(required):
object PosPlatform
Identifies the POS platform running at the location (not the software version). The response version is always 2.
-
timezone:
object Timezone
Represents the associated timezone
{
"orgShortName":"tfoinc",
"locRef":"fdmnh144",
"name":"Fred Dome Stadium",
"currency":"USD",
"languages":[
"en-GB",
"fr-FR",
"de-DE"
],
"timezone":{
"ianaName":"Europe/London",
"windowsName":"GMT Standard Time",
"tzIndex":85
},
"address":{
"addressLine1":"144 W 94th St",
"addressLine2":"Suite 11F",
"floor":"42A",
"locality":"New York",
"region":"NY",
"postalCode":"10019",
"country":"USA",
"notes":"West Entrance"
},
"phoneNumber":"(0030) 0456 343 234",
"geoLocation":{
"latitude":40.773188,
"longitude":-73.994835
},
"posPlatform":{
"name":"Oracle.Simphony",
"version":"2"
}
}object-
addressLine1:
string
First line of an address
-
addressLine2:
string
Second line of an address
-
addressLine3:
string
Third line of an address
-
country:
string
name of country, or country code
-
floor:
string
The floor in a building.
-
locality:
string
city/town/village
-
notes:
string
Additional address details
-
postalcode:
string
postal code, e.g. ZIP in the US
-
region:
string
state/county/province
objectobject-
latitude:
number
Minimum Value:
-90Maximum Value:90WGS84 latitude, in degrees -
longitude:
number
Minimum Value:
-180Maximum Value:180WGS84 Longitude, in degrees
array[
"en-GB",
"fr-FR",
"de-DE"
]object-
name(required):
string
Name of the platform
-
version(required):
string
Version of the platform
object-
ianaName:
string
Name in linux OS system
-
tzIndex(required):
integer
The integer representation of the Index column from https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
-
windowsName:
string
Name in windows OS system
object400 Response
object-
details:
string
A human-readable explanation specific to this occurrence of the problem.
-
instance:
string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
-
title:
string
A short, human-readable summary of the problem type.
-
type:
string
A URI reference [RFC3986](https://tools.ietf.org/html/rfc3986) that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".
{
"type":"error:validation",
"title":"Required value not specified.",
"details":"The OrgShortName value is required.",
"instance":"required_value_missing"
}401 Response
-
WWW-Authenticate: string
Bearer authentication challenge. When token validation fails, the header may include error and error_description parameters.
The following conditions and HTTP response examples are illustrative and not exhaustive. Error descriptions may vary.
No token provided: No access token is provided, or the Authorization request header is missing. The response header is WWW-Authenticate: Bearer, without error or error_description parameters.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: BearerExpired token: The access token has expired. The timestamp in this example is illustrative.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired at '05/19/2026 17:16:29'"Signing key not found: The token cannot be validated because its signing key was not found. For example, the token's key ID (kid) does not match a key in the JSON Web Key Set (JWKS) used for validation.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature key was not found"Invalid signature: The token signature is invalid. For example, the token may have been modified.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature is invalid"For the missing-token, signing-key-not-found, and invalid-signature examples above, the response body is empty. The authentication error details are provided in the WWW-Authenticate response header.
The response may include an additional WWW-Authenticate header containing a bare Bearer challenge alongside the challenge shown in these examples.
403 Response
404 Response
Examples
Example Request Body
Not applicable for this endpoint.
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"limit": 0,
"offset": 0,
"count": 0,
"items": [
{
"orgShortName": "tfoinc",
"locRef": "fdmnh144",
"name": "The Food Organization Inc",
"currency": "USD",
"languages": [
"en-GB",
"fr-FR",
"de-DE"
],
"timezone": {
"ianaName": "America/New_York",
"windowsName": "Eastern Standard Time",
"tzIndex": 23
},
"address": {
"addressLine1": "144 W 54th St",
"addressLine2": "Suite 11B",
"floor": "42A",
"locality": "New York",
"region": "NY",
"postalCode": "10019",
"country": "USA",
"notes": "West Entrance"
},
"phoneNumber": "(0030) 0453 343 234",
"geoLocation": {
"latitude": 40.763188,
"longitude": -73.914835
},
"posPlatform": {
"name": "Oracle.Simphony",
"version": "2"
}
}
]
}