DocumentationAPI Reference
API Reference

List job locations

get
https://{companyDomain}.bamboohr.com/api/v1/hris/org/locations

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 500

The number of items to return per page.

integer
Defaults to 0

The page number to retrieve.

string

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

string

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

string

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

expand
array of strings
Defaults to

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

expand
Responses

Updated 3 days ago

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 days ago