GET
/
unified
/
hris
/
employments
/
{id}
curl --request GET \
  --url https://api.stackone.com/unified/hris/employments/{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",
    "job_title": "Software Engineer",
    "pay_rate": "40.00",
    "pay_period": "monthly",
    "pay_frequency": "hourly",
    "pay_currency": "USD",
    "fte": "1",
    "effective_date": "2021-01-01T01:01:01.000Z",
    "employment_type": "permanent",
    "employment_contract_type": "full_time",
    "work_time": {
      "duration": "P0Y0M0DT8H0M0S",
      "duration_unit": "month"
    },
    "payroll_code": "PC1",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "start_date": "2021-01-01T01:01:01.000Z",
    "end_date": "2021-01-01T01:01:01.000Z",
    "active": true,
    "department": {
      "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"
      },
      "name": "Engineering",
      "parent_ids": [
        "cxIQNjUyNDM0",
        "cxIQNjQzNzI0MQ"
      ],
      "remote_parent_ids": [
        "652434",
        "6437241"
      ],
      "owner_ids": [
        "cxIQNjUyEDM0",
        "cxIQNjQzNzA0MQ"
      ],
      "remote_owner_ids": [
        "475364",
        "4327652"
      ],
      "company_id": "1234567890",
      "remote_company_id": "1234567890",
      "type": {
        "value": "team",
        "source_value": "<string>"
      }
    },
    "cost_center": {
      "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"
      },
      "name": "Engineering",
      "parent_ids": [
        "cxIQNjUyNDM0",
        "cxIQNjQzNzI0MQ"
      ],
      "remote_parent_ids": [
        "652434",
        "6437241"
      ],
      "owner_ids": [
        "cxIQNjUyEDM0",
        "cxIQNjQzNzA0MQ"
      ],
      "remote_owner_ids": [
        "475364",
        "4327652"
      ],
      "company_id": "1234567890",
      "remote_company_id": "1234567890",
      "type": {
        "value": "team",
        "source_value": "<string>"
      }
    },
    "cost_centers": [
      {
        "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"
        },
        "name": "Engineering",
        "parent_ids": [
          "cxIQNjUyNDM0",
          "cxIQNjQzNzI0MQ"
        ],
        "remote_parent_ids": [
          "652434",
          "6437241"
        ],
        "owner_ids": [
          "cxIQNjUyEDM0",
          "cxIQNjQzNzA0MQ"
        ],
        "remote_owner_ids": [
          "475364",
          "4327652"
        ],
        "company_id": "1234567890",
        "remote_company_id": "1234567890",
        "distribution_percentage": 85,
        "type": {
          "value": "team",
          "source_value": "<string>"
        }
      }
    ],
    "division": {
      "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"
      },
      "name": "Engineering",
      "parent_ids": [
        "cxIQNjUyNDM0",
        "cxIQNjQzNzI0MQ"
      ],
      "remote_parent_ids": [
        "652434",
        "6437241"
      ],
      "owner_ids": [
        "cxIQNjUyEDM0",
        "cxIQNjQzNzA0MQ"
      ],
      "remote_owner_ids": [
        "475364",
        "4327652"
      ],
      "company_id": "1234567890",
      "remote_company_id": "1234567890",
      "type": {
        "value": "team",
        "source_value": "<string>"
      }
    },
    "job": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "title": "Software Engineer",
      "description": {
        "text": "Testing the laws of motion"
      },
      "owner_id": "5356",
      "parent_id": "7577"
    },
    "type": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "label": "Permanent",
      "type": "permanent"
    },
    "contract_type": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "label": "Full-Time",
      "contract_type": "full_time"
    },
    "manager": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "role": {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "label": "Admin",
          "role_type": "admin"
        }
      }
    ]
  },
  "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

​
id
string
required

Query Parameters

​
raw
boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

​
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,job_title,pay_rate,pay_period,pay_frequency,pay_currency,fte,effective_date,employment_type,employment_contract_type,work_time,payroll_code,created_at,updated_at,start_date,end_date,active,department,team,cost_center,cost_centers,division,job,type,contract_type,manager"

​
expand
string | null

The comma separated list of fields that will be expanded in the response

Example:

"groups"

Response

200
application/json
The Employment with the given identifier was retrieved.

The response is of type object.