v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Locations

Public API

List job locations

Retrieves a paginated list of job locations. Returns active locations by default. Supports pagination via page and pageSize query parameters.

OAuth Scopes: field

get/api/v1/hris/org/locations

Query parameters

pageSizeinteger

The number of items to return per page.

pageinteger

The page number to retrieve.

sortstring

Ordering by OData (Open Data Protocol) v4 specification. Supported fields: label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation, createdAt, archivedAt

selectstring

Projection (field selection) by OData specification. Supported fields: id, label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation, createdAt, archivedAt

filterstring

Filter by an OData (Open Data Protocol) v4 specification. Supported fields: id, label, archived, manageable, address/address1, address/address2, address/city, address/stateId, address/zipcode, address/countryId, address/timezone, address/remoteLocation

expandstring[]

Comma-separated list of related resources to expand. Supported values: state, country. Example: expand=state,country

Response

A paginated list of job locations

_linksobject nullable

Hypermedia links for collection navigation (next, prev) and available collection actions (e.g., create). Actions are permission-based and may vary.

Example response

{
  "meta": {
    "pageSize": 100,
    "totalPages": 1,
    "totalItems": 10
  },
  "_links": {
    "next": {
      "href": "/api/v1/reference-resources?page=2&pageSize=100"
    },
    "prev": {
      "href": "/api/v1/reference-resources?page=0&pageSize=100"
    }
  }
}