Get Employee Employment

curl --request GET \
  --url https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId} \
  --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"
    },
    "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",
    "end_date": "2021-01-01T01:01:01.000Z",
    "grade": {
      "id": "1687-3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "1687-4",
      "description": "Mid-level employee demonstrating proficiency and autonomy."
    },
    "employment_type": "permanent",
    "employment_contract_type": "full_time",
    "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"
    },
    "work_time": {
      "duration": "P0Y0M0DT8H0M0S",
      "period": "month"
    },
    "payroll_code": "PC1",
    "employee_id": "1687-3",
    "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "fte": "1",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "start_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"
    },
    "manager": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "John Doe",
        "email": "[email protected]",
        "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": {},
      "response": {}
    }
  ]
}

GET

unified

hris

employees

{id}

employments

{subResourceId}

Get Employee Employment

curl --request GET \
  --url https://api.stackone.com/unified/hris/employees/{id}/employments/{subResourceId} \
  --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"
    },
    "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",
    "end_date": "2021-01-01T01:01:01.000Z",
    "grade": {
      "id": "1687-3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "1687-4",
      "description": "Mid-level employee demonstrating proficiency and autonomy."
    },
    "employment_type": "permanent",
    "employment_contract_type": "full_time",
    "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"
    },
    "work_time": {
      "duration": "P0Y0M0DT8H0M0S",
      "period": "month"
    },
    "payroll_code": "PC1",
    "employee_id": "1687-3",
    "remote_employee_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
    "fte": "1",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "start_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"
    },
    "manager": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "John Doe",
        "email": "[email protected]",
        "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": {},
      "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

subResourceId

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

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,end_date,employment_type,employment_contract_type,type,contract_type,change_reason,grade,work_time,payroll_code,fte,created_at,updated_at,start_date,active,department,team,cost_center,cost_centers,division,job,manager,groups,unified_custom_fields"

expand

string | null

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

Example:

"groups"

Response

The Employee Employment with the given identifier was retrieved.

data

object

required

Show child attributes

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

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.job_title

string | null

The job title of the employee

Example:

"Software Engineer"

data.pay_rate

string | null

The amount of compensation for the employee

Example:

"40.00"

data.pay_period

object

The time period over which the pay rate is calculated

Show child attributes

data.pay_period.value

enum<string> | null

Available options:

hour,

day,

week,

every_two_weeks,

month,

quarter,

every_six_months,

year,

unmapped_value,

data.pay_period.source_value

Example:

"monthly"

data.pay_frequency

object

How often the employee is paid

Show child attributes

data.pay_frequency.value

enum<string> | null

Available options:

hourly,

weekly,

bi_weekly,

four_weekly,

semi_monthly,

monthly,

bi_monthly,

quarterly,

semi_annually,

yearly,

thirteen_monthly,

pro_rata,

unmapped_value,

half_yearly,

daily,

fixed,

data.pay_frequency.source_value

Example:

"hourly"

data.pay_currency

string | null

The currency used for pay

Example:

"USD"

data.effective_date

string<date-time> | null

The effective date of the employment contract

Example:

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

data.end_date

string<date-time> | null

The end date of employment

Example:

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

data.grade

object

Represents the employee’s position within the organizational hierarchy.

Show child attributes

data.grade.id

string | null

The reference id

Example:

"1687-3"

data.grade.remote_id

string | null

Provider's unique identifier

Example:

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

data.grade.name

string | null

The reference name

Example:

"1687-4"

data.grade.description

string | null

description of the grade

Example:

"Mid-level employee demonstrating proficiency and autonomy."

data.employment_type

object

deprecated

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

Show child attributes

data.employment_type.value

enum<string> | null

Available options:

contractor,

intern,

permanent,

apprentice,

freelance,

terminated,

temporary,

seasonal,

volunteer,

probation,

internal,

external,

expatriate,

employer_of_record,

casual,

Programme,

unmapped_value,

data.employment_type.source_value

Example:

"permanent"

data.employment_contract_type

object

deprecated

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

Show child attributes

data.employment_contract_type.value

enum<string> | null

Available options:

full_time,

shifts,

part_time,

unmapped_value,

data.employment_contract_type.source_value

Example:

"full_time"

data.type

object

The type of employment

Show child attributes

data.type.id

string | null

Unique identifier

Example:

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

data.type.remote_id

string | null

Provider's unique identifier

Example:

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

data.type.label

string | null

The label of the employment type

Example:

"Permanent"

data.type.type

object

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

Show child attributes

data.type.type.value

enum<string> | null

Available options:

contractor,

intern,

permanent,

apprentice,

freelance,

terminated,

temporary,

seasonal,

volunteer,

probation,

internal,

external,

expatriate,

employer_of_record,

casual,

Programme,

unmapped_value,

data.type.type.source_value

Example:

"permanent"

data.contract_type

object

The employment work schedule type

Show child attributes

data.contract_type.id

string | null

Unique identifier

Example:

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

data.contract_type.remote_id

string | null

Provider's unique identifier

Example:

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

data.contract_type.label

string | null

The label of the employment type

Example:

"Full-Time"

data.contract_type.contract_type

object

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

Show child attributes

data.contract_type.contract_type.value

enum<string> | null

Available options:

full_time,

shifts,

part_time,

unmapped_value,

data.contract_type.contract_type.source_value

Example:

"full_time"

data.work_time

object

Show child attributes

data.work_time.duration

string<duration> | null

The work time duration in ISO 8601 duration format

Example:

"P0Y0M0DT8H0M0S"

data.work_time.period

object

The period of the work time

Show child attributes

data.work_time.period.value

enum<string> | null

The unified value for the period.

Available options:

day,

week,

month,

year,

unmapped_value,

Example:

"month"

data.work_time.period.source_value

Example:

"month"

data.payroll_code

string | null

The payroll code of the employee

Example:

"PC1"

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.fte

number | null

the employee's working percentage relative to a full-time employee

Example:

"1"

data.created_at

string<date-time> | null

The created_at date

Example:

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

data.updated_at

string<date-time> | null

The updated_at date

Example:

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

data.start_date

string<date-time> | null

deprecated

The start_date of employment

Example:

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

data.active

The employment active status

Example:

true

data.department

object

The employee department

Show child attributes

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

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.company_id

string | null

The id of the company that the group belongs to

Example:

"1234567890"

data.department.remote_company_id

string | null

Provider's id of the company that the group belongs to

Example:

"1234567890"

data.department.type

object

The type of the group

Show child attributes

data.department.type.value

enum<string> | null

Available options:

workspace,

team,

department,

group,

organization,

unmapped_value,

cost_center,

Example:

"team"

data.department.type.source_value

data.cost_center

object

deprecated

The employee cost_center

Show child attributes

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

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.company_id

string | null

The id of the company that the group belongs to

Example:

"1234567890"

data.cost_center.remote_company_id

string | null

Provider's id of the company that the group belongs to

Example:

"1234567890"

data.cost_center.type

object

The type of the group

Show child attributes

data.cost_center.type.value

enum<string> | null

Available options:

workspace,

team,

department,

group,

organization,

unmapped_value,

cost_center,

Example:

"team"

data.cost_center.type.source_value

data.cost_centers

object[] | null

The employee cost_centers

Show child attributes

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

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.company_id

string | null

The id of the company that the group belongs to

Example:

"1234567890"

data.cost_centers.remote_company_id

string | null

Provider's id of the company that the group belongs to

Example:

"1234567890"

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

Show child attributes

data.cost_centers.type.value

enum<string> | null

Available options:

workspace,

team,

department,

group,

organization,

unmapped_value,

cost_center,

Example:

"team"

data.cost_centers.type.source_value

data.division

object

The employee division

Show child attributes

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

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.company_id

string | null

The id of the company that the group belongs to

Example:

"1234567890"

data.division.remote_company_id

string | null

Provider's id of the company that the group belongs to

Example:

"1234567890"

data.division.type

object

The type of the group

Show child attributes

data.division.type.value

enum<string> | null

Available options:

workspace,

team,

department,

group,

organization,

unmapped_value,

cost_center,

Example:

"team"

data.division.type.source_value

data.job

object

The job of employee

Show child attributes

data.job.id

string | null

Unique identifier

Example:

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

data.job.remote_id

string | null

Provider's unique identifier

Example:

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

data.job.title

string | null

Title of the job

Example:

"Software Engineer"

data.job.description

object

The employee job description

Show child attributes

data.job.description.text

string | null

Example:

"Testing the laws of motion"

data.job.owner_id

string | null

The owner_id of the job

Example:

"5356"

data.job.parent_id

string | null

The parent_id of the job

Example:

"7577"

data.manager

object[] | null

The employee manager

Show child attributes

data.manager.id

string | null

Unique identifier

Example:

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

data.manager.remote_id

string | null

Provider's unique identifier

Example:

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

data.manager.name

string | null

The manager name

Example:

"John Doe"

data.manager.email

string | null

The manager email

Example:

"[email protected]"

data.manager.role

object

The role of manager

Show child attributes

data.manager.role.id

string | null

Unique identifier

Example:

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

data.manager.role.remote_id

string | null

Provider's unique identifier

Example:

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

data.manager.role.label

string | null

The label of the role type

Example:

"Admin"

data.manager.role.role_type

object

The manager role type (e.g., admin, viewer)

Show child attributes

data.manager.role.role_type.value

enum<string> | null

Available options:

admin,

viewer,

editor,

basic,

guest,

unassigned,

restricted,

unmapped_value,

data.manager.role.role_type.source_value

Example:

"admin"

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

Create Employee Employment Update Employee Employment

⌘I

Getting Started

Use Cases

API Reference

Get Employee Employment

Authorizations

Headers

Path Parameters

Query Parameters

Response