Locations
locations Based on latest (2026.09)
Look up Locations. Read-only.
The record key locationsUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
Oracle documents an Effective-Of header and an effectiveDate parameter for this resource, used for date-effective reads and changes.
- Operations
- GET (list)GET (one)
- Record key
locationsUniqID- Required on create
- no create on this resource
- At a glance
- 40 fields2 finders1 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/locations?fields=ActiveStatus,AddressLine1,AddressLine2,AddressLine3,AddressLine4&limit=25&onlyData=true
{
"items": [
{
"ActiveStatus": "A",
"AddressLine1": "<string, max 240>",
"AddressLine2": "<string, max 240>",
"AddressLine3": "<string, max 240>",
"AddressLine4": "<string, max 240>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 40
| Attribute | Type | Use |
|---|---|---|
ActiveStatus | text · max 30 · default A | Searchable |
AddressLine1 | text · max 240 | Searchable |
AddressLine2 | text · max 240 | Searchable |
AddressLine3 | text · max 240 | Searchable |
AddressLine4 | text · max 240 | Searchable |
AnnualWorkingDurationUnits | text · max 10 | Searchable |
BillToSiteFlag | yes/no · max 30 · default true | Searchable |
Country | text · max 60 | Searchable |
CreationDate | date-time | Read-only |
DeliverToSiteFlag | yes/no · max 1 · default true | Searchable |
Description | text · max 240 | |
EffectiveEndDate | date | Searchable |
EffectiveStartDate | date | Searchable |
EmailAddress | text · max 240 | |
EmployeeLocationFlag | yes/no · max 1 · default true | Searchable |
LastUpdateDate | date-time | Read-onlySearchable |
Latitude | number | Searchable |
LocationCode | text · max 120 | Searchable |
LocationId | number | Searchable |
LocationName | text · max 60 | Searchable |
Longitude | number | Searchable |
MainAddressId | number · default 1 | |
OfficeSiteFlag | yes/no · max 30 · default true | Searchable |
PostalCode | text · max 30 | Searchable |
Provider | text · max 150 | Searchable |
ReceivableMaterials | text · max 2000 | Searchable |
ReceivingSiteFlag | yes/no · max 30 · default true | Searchable |
Region1 | text · max 120 | Searchable |
Region2 | text · max 120 | Searchable |
Region3 | text · max 120 | Searchable |
SetId | number | Searchable |
ShipToSiteFlag | yes/no · max 30 · default true | Searchable |
StandardAnnualWorkingDuration | number | Searchable |
StandardWorkingFrequency | text · max 30 | Searchable |
StandardWorkingHours | number | Searchable |
TelephoneNumber1 | text · max 240 | |
TelephoneNumber2 | text · max 240 | |
TelephoneNumber3 | text · max 240 | |
TownOrCity | text · max 60 | Searchable |
ValidationStatusCode | text · max 120 | Searchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 2
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
AlternateKey·LocationCodeSetIdfindByLocationId·LocationIdSysEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 1
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/locations/{locationsUniqID}/child/<name>. Add them to a GET with expand.
LocationDFFGET Locations Descriptive Flexfields · 5 fieldsEffectiveEndDateEffectiveStartDateLocationDetailsId__FLEX_Context__FLEX_Context_DisplayValue
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/locationsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
AlternateKeyfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:ActiveStatus, notactivestatus. onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through.