List Employments

GET

unified

hris

employments

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

{
  "next_page": "<string>",
  "next": "<string>",
  "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",
      "effective_date": "2021-01-01T01:01:01.000Z",
      "employment_type": "permanent",
      "employment_contract_type": "full_time",
      "time_worked": "P0Y0M0DT8H0M0S",
      "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"
        ],
        "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"
        ],
        "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"
          ],
          "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"
        ],
        "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

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

filter

object | null

Filter parameters that allow greater customisation of the list response

page

string | null

deprecated

The page number of the results to fetch

page_size

string | null

default:25

The number of results per page

string | null

The unified cursor

updated_after

string | null

deprecated

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

expand

string | null

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

Example:

"groups"

Response

200

application/json

The list of Employments 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 associated with this employment

Example:

"1687-3"

data.remote_employee_id

string | null

Provider's unique identifier of the employee associated with this employment

Example:

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

data.job_title

string | null

deprecated

The job title of the employee

Example:

"Software Engineer"

data.pay_rate

string | null

The pay rate for the employee

Example:

"40.00"

data.pay_period

object

The pay period

Example:

"monthly"

data.pay_frequency

object

The pay frequency

Example:

"hourly"

data.pay_currency

string | null

The currency used for pay

Example:

"USD"

data.effective_date

string | null

The effective date of the employment contract

Example:

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

data.employment_type

object

deprecated

The type of employment (e.g., contractor, permanent)

Example:

"permanent"

data.employment_contract_type

object

deprecated

The employment work schedule type (e.g., full-time, part-time)

Example:

"full_time"

data.time_worked

string | null

The time worked for the employee in ISO 8601 duration format

Example:

"P0Y0M0DT8H0M0S"

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"

data.start_date

string | null

The start_date of employment

Example:

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

data.end_date

string | null

The end_date of employment

Example:

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

data.active

boolean | null

The employment active status

Example:

true

data.department

object

The employee department

data.department.id

string | null

Unique identifier

Example:

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

data.department.remote_id

string | null

Provider's unique identifier

Example:

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

data.department.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.department.name

string | null

The name of the group

Example:

"Engineering"

data.department.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.department.remote_parent_ids

string[] | null

Provider's list of parent group remote ids of the given group

Example:

["652434", "6437241"]

data.department.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.department.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.department.type

object

The type of the group

data.cost_center

object

deprecated

The employee cost_center

data.cost_center.id

string | null

Unique identifier

Example:

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

data.cost_center.remote_id

string | null

Provider's unique identifier

Example:

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

data.cost_center.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.cost_center.name

string | null

The name of the group

Example:

"Engineering"

data.cost_center.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.cost_center.remote_parent_ids

string[] | null

Provider's list of parent group remote ids of the given group

Example:

["652434", "6437241"]

data.cost_center.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.cost_center.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.cost_center.type

object

The type of the group

data.cost_centers

object[] | null

The employee cost_centers

data.cost_centers.id

string | null

Unique identifier

Example:

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

data.cost_centers.remote_id

string | null

Provider's unique identifier

Example:

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

data.cost_centers.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.cost_centers.name

string | null

The name of the group

Example:

"Engineering"

data.cost_centers.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.cost_centers.remote_parent_ids

string[] | null

Provider's list of parent group remote ids of the given group

Example:

["652434", "6437241"]

data.cost_centers.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.cost_centers.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.cost_centers.distribution_percentage

number | null

The distribution percentage for cost_center

Example:

85

data.cost_centers.type

object

The type of the group

data.division

object

The employee division

data.division.id

string | null

Unique identifier

Example:

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

data.division.remote_id

string | null

Provider's unique identifier

Example:

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

data.division.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.division.name

string | null

The name of the group

Example:

"Engineering"

data.division.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.division.remote_parent_ids

string[] | null

Provider's list of parent group remote ids of the given group

Example:

["652434", "6437241"]

data.division.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.division.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.division.type

object

The type of the group

data.job

object

The job of employee

data.type

object

The type of employment

data.contract_type

object

The employment work schedule type

data.manager

object[] | null

The employee manager

next_page

string | null

deprecated

string | null

raw

object[] | null

Was this page helpful?

Suggest edits

Get Employment Get Cost Center Group

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

{
  "next_page": "<string>",
  "next": "<string>",
  "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",
      "effective_date": "2021-01-01T01:01:01.000Z",
      "employment_type": "permanent",
      "employment_contract_type": "full_time",
      "time_worked": "P0Y0M0DT8H0M0S",
      "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"
        ],
        "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"
        ],
        "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"
          ],
          "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"
        ],
        "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": {}
    }
  ]
}

HRIS

Common Guides

API Reference

Authorizations

Headers

Query Parameters

Response