Get Location

GET

unified

hris

locations

{id}

curl --request GET \
  --url https://api.stackone.com/unified/hris/locations/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "employee_id": "1687-3",
    "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "name": "Woolsthorpe Manor",
    "phone_number": "+44 1476 860 364",
    "street_1": "Water Lane",
    "street_2": "Woolsthorpe by Colsterworth",
    "city": "Grantham",
    "state": "Lincolnshire",
    "zip_code": "NG33 5NR",
    "country": {
      "value": "US",
      "source_value": "<string>"
    },
    "location_type": "work",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

default:false

Indicates that the raw request result is returned

proxy

object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

Example:

"id,remote_id,employee_id,remote_employee_id,name,phone_number,street_1,street_2,city,state,zip_code,country,location_type,created_at,updated_at"

Response

200

application/json

The Location with the given identifier was retrieved.

data

object

required

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.employee_id

string | null

The employee ID

Example:

"1687-3"

data.remote_employee_id

string | null

Provider's unique identifier of the employee

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.name

string | null

The name of the location

Example:

"Woolsthorpe Manor"

data.phone_number

string | null

The phone number of the location

Example:

"+44 1476 860 364"

data.street_1

string | null

The first line of the address

Example:

"Water Lane"

data.street_2

string | null

The second line of the address

Example:

"Woolsthorpe by Colsterworth"

data.city

string | null

The city where the location is situated

Example:

"Grantham"

data.state

string | null

The state where the location is situated

Example:

"Lincolnshire"

data.zip_code

string | null

The ZIP code/Postal code of the location

Example:

"NG33 5NR"

data.country

object

The country code

data.location_type

object

The location type

Example:

"work"

data.created_at

string | null

The created_at date

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string | null

The updated_at date

Example:

"2021-01-01T01:01:01.000Z"

raw

object[] | null

Was this page helpful?

Suggest edits

List Jobs List locations

curl --request GET \
  --url https://api.stackone.com/unified/hris/locations/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "employee_id": "1687-3",
    "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "name": "Woolsthorpe Manor",
    "phone_number": "+44 1476 860 364",
    "street_1": "Water Lane",
    "street_2": "Woolsthorpe by Colsterworth",
    "city": "Grantham",
    "state": "Lincolnshire",
    "zip_code": "NG33 5NR",
    "country": {
      "value": "US",
      "source_value": "<string>"
    },
    "location_type": "work",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

HRIS

Common Guides

API Reference

Authorizations

Headers

Path Parameters

Query Parameters

Response