Skip to main content
POST
/
locations
Create Location
curl --request POST \
  --url https://api.roostedhr.com/api/1_12/locations \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "location": "Henry Park",
  "address": "1325 S Ellis St, Wichita, KS 67211, USA",
  "city": "Wichita",
  "zip": "67211",
  "color": "#DC136C",
  "location_comments": "",
  "timezone_id": 4,
  "default_clients_id": "hAjwQ",
  "default_areas": []
}
'
{
  "id": "78590",
  "location": "Henry Park",
  "addy_street_number": "1325 S Ellis St, Wichita, KS 67211, USA",
  "addy_city": "Wichita",
  "addy_zip": "67211",
  "location_comments": null,
  "default": null,
  "saved": 1,
  "color": "#DC136C",
  "timezone": {
    "id": 4,
    "name": "America/Denver",
    "offset": "-07:00"
  },
  "companies_payroll_rulesets_id": null,
  "payroll_rule_display": null,
  "latitude": "37.669422",
  "longitude": "-97.320435",
  "default_clients_id": "hAjwQ",
  "default_areas": []
}
The location, address, city, zip, and timezone_id fields are required. All other fields are optional.
Use the default_areas field to associate areas with the location at creation time. Area IDs can be retrieved from the Get Areas endpoint.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json

Location details

​
location
string
required

Location name

Required string length: 1 - 150
​
address
string
required

Street address

Required string length: 1 - 150
​
city
string
required

City

Required string length: 1 - 75
​
zip
string
required

ZIP/postal code

Required string length: 1 - 10
​
timezone_id
integer
required

Timezone identifier

Required range: x <= 999
​
color
string

Hex color code

Maximum string length: 7
​
location_comments
string

Additional comments

Maximum string length: 65535
​
default_clients_id
string

Default client hashed ID

Maximum string length: 5
​
default_areas
string[]

Default area IDs

Response

Created

​
id
string

Location identifier

​
location
string

Location name

​
addy_street_number
string

Street address

​
addy_city
string

City

​
addy_zip
string

ZIP/postal code

​
location_comments
string | null

Additional comments

​
default
integer | null

Whether this is the default location (0 or 1)

Required range: 0 <= x <= 1
​
saved
integer | null

Whether the location is saved (0 or 1)

Required range: 0 <= x <= 1
​
color
string | null

Hex color code

Example:

"#DC136C"

​
timezone
object

Location timezone

​
companies_payroll_rulesets_id
string | null

Associated payroll ruleset ID

​
payroll_rule_display
string | null

Payroll rule display name

​
latitude
string | null

GPS latitude coordinate

​
longitude
string | null

GPS longitude coordinate

​
default_clients_id
string | null

Default client hashed ID

​
default_areas
string[]

Default area IDs