v1

latestOpenAPI 3.1.02026-08-042784116.2 KB

Add Location

Returns the specified location that is associated with the authenticated legal entity. An optional configuration can be provided to help decide if some tasks should be included or not.

<table> <tr><td>has_employees</td><td>Include or filter out tasks that are applicable when employees are living or working in the location. Once payroll is connected for the legal entity, this value will be kept in sync.</td></tr> <tr><td>has_physical_location</td><td>Include or filter out tasks that are applicable when the legal entity has a physical presence (such as an office) in the location.</td></tr> </table>

This table maps Location IDs to the state abbreviation code it represents. The IDs are globally unique and are used regardless of which legal entity is authenticated.

<table> <tr><td>e5aa6d3222d22de2</td><td>AL</td></tr> <tr><td>86e384ec4456dd93</td><td>AK</td></tr> <tr><td>43c2b058fdc38bd0</td><td>AZ</td></tr> <tr><td>8a3248de4ff636d4</td><td>AR</td></tr> <tr><td>99be5e8f54c4680d</td><td>CA</td></tr> <tr><td>e8239e013ff4cde4</td><td>CO</td></tr> <tr><td>e69817cba25a7fa6</td><td>CT</td></tr> <tr><td>1f1cc147c009b409</td><td>DE</td></tr> <tr><td>afb903b3dcbe23fc</td><td>DC</td></tr> <tr><td>33cf440c464d38f5</td><td>FL</td></tr> <tr><td>5c392fde8d78eb3c</td><td>GA</td></tr> <tr><td>dcb44d856176eb43</td><td>HI</td></tr> <tr><td>a71f627b1843088a</td><td>ID</td></tr> <tr><td>30c18f24ba96c1e2</td><td>IL</td></tr> <tr><td>fbe3a2db6d46f2fe</td><td>IN</td></tr> <tr><td>81fb4925ba83f81b</td><td>IA</td></tr> <tr><td>f60f094906bf6e61</td><td>KS</td></tr> <tr><td>0fced19468cca680</td><td>KY</td></tr> <tr><td>b51b14eb685c802f</td><td>LA</td></tr> <tr><td>50b6e06268188bff</td><td>ME</td></tr> <tr><td>784c3796c1f6931f</td><td>MD</td></tr> <tr><td>d26e531db2dcbb50</td><td>MA</td></tr> <tr><td>b07e8933d62889e9</td><td>MI</td></tr> <tr><td>2577a77a916b01bd</td><td>MN</td></tr> <tr><td>4641d29a7416dae8</td><td>MS</td></tr> <tr><td>4eecb1031e0ecc97</td><td>MO</td></tr> <tr><td>3c6de0a85af1153b</td><td>MT</td></tr> <tr><td>47b790d36c9135fe</td><td>NE</td></tr> <tr><td>c2473d37f8547551</td><td>NV</td></tr> <tr><td>e4656a4c283b7c15</td><td>NH</td></tr> <tr><td>a3cc7e50a63fb347</td><td>NJ</td></tr> <tr><td>43ca15ae2aa526e9</td><td>NM</td></tr> <tr><td>5894aa7b4729ed13</td><td>NY</td></tr> <tr><td>aa79248e404b74d2</td><td>NC</td></tr> <tr><td>5528e71a2a626676</td><td>ND</td></tr> <tr><td>ff6fec03fcfaa7d1</td><td>OH</td></tr> <tr><td>36552f81875623ad</td><td>OK</td></tr> <tr><td>e3fd17f3f015b908</td><td>OR</td></tr> <tr><td>1c96f4e30d829772</td><td>PA</td></tr> <tr><td>1e58e23ec4a87036</td><td>RI</td></tr> <tr><td>d2bbb1305f460a69</td><td>SC</td></tr> <tr><td>4e4a5bc7fcf5abd2</td><td>SD</td></tr> <tr><td>13f00f61a16fdabd</td><td>TN</td></tr> <tr><td>7dac61e5b25e151a</td><td>TX</td></tr> <tr><td>5da0217cd400f37a</td><td>UT</td></tr> <tr><td>3683a6d2eec6b45c</td><td>VT</td></tr> <tr><td>f568e8571666ccd6</td><td>VA</td></tr> <tr><td>05a2dfcf81d37e7d</td><td>WA</td></tr> <tr><td>aa5a1dfcbdd37d25</td><td>WV</td></tr> <tr><td>920abf5751681231</td><td>WI</td></tr> <tr><td>0132461d340cded0</td><td>WY</td></tr> </table>
put/locations/{location_public_id}

Path parameters

location_public_idstring required

Request body

Response

Successful Response