List Employees

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,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,benefits,company,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,company_id,remote_company_id,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number,national_identity_number,national_identity_numbers,skills"

filter

object | null

HRIS Employees filters

Show child attributes

filter.updated_after

string | null

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

Example:

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

filter.email

string | null

Filter to select employees by email

filter.employee_number

string | null

Filter to select employees by employee_number

page

string | null

deprecated

The page number of the results to fetch

page_size

string | null

default:25

The number of results per page

next

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:

"company,employments,work_location,home_location,groups,skills"

include

string | null

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

Example:

"avatar_url,avatar,custom_fields,job_description,benefits"

Response

200

application/json

The list of employees 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 | 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.first_name

string | null

The employee first name

Example:

"Issac"

data.last_name

string | null

The employee last name

Example:

"Newton"

data.name

string | null

The employee name

Example:

"Issac Newton"

data.display_name

string | null

The employee display name

Example:

"Sir Issac Newton"

data.avatar_url

string | null

The employee avatar Url

Example:

"https://example.com/avatar.png"

data.personal_email

string | null

The employee personal email

Example:

"[e-mail]"

data.personal_phone_number

string | null

The employee personal phone number

Example:

"[phone]"

data.work_email

string | null

The employee work email

Example:

"[e-mail]"

data.work_phone_number

string | null

The employee work phone number

Example:

"[phone]"

data.job_id

string | null

deprecated

The employee job id

Example:

"5290"

data.job_title

string | null

deprecated

The employee job title

Example:

"Physicist"

data.job_description

object

deprecated

The employee job description

Show child attributes

data.job_description.text

string | null

Example:

"Testing the laws of motion"

Example:

"Testing the laws of motion"

data.department_id

string | null

deprecated

The employee department id

Example:

"3093"

data.department

string | null

deprecated

The employee department

Example:

"Physics"

data.groups

object[] | null

The employee groups

Show child attributes

data.groups.id

string | null

Unique identifier

Example:

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

data.groups.remote_id

string | null

Provider's unique identifier

Example:

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

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

string | null

The name of the group

Example:

"Engineering"

data.groups.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.groups.remote_parent_ids

string[] | null

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

Example:

["652434", "6437241"]

data.groups.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.groups.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.groups.type

object

The type of the group

Show child attributes

data.groups.type.value

enum<string> | null

Available options:

workspace,

team,

department,

group,

organization,

unmapped_value,

cost_center

Example:

"team"

data.groups.type.source_value

data.cost_centers

object[] | null

deprecated

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

string | null

Example:

"R&D"

data.cost_centers.distribution_percentage

number | null

Example:

100

data.manager_id

string | null

deprecated

The employee manager ID

Example:

"67890"

data.remote_manager_id

string | null

Provider's unique identifier of the manager

Example:

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

data.gender

object

The employee gender

Show child attributes

data.gender.value

enum<string> | null

Available options:

male,

female,

non_binary,

other,

not_disclosed,

diverse,

unmapped_value

data.gender.source_value

Example:

"male"

data.preferred_language

object

The employee preferred language

Show child attributes

data.preferred_language.value

enum<string> | null

The ISO639-2 Code of the language

Available options:

aar,

afr,

amh,

ara,

aym,

aze,

bel,

bul,

bis,

ben,

bos,

byn,

cat,

cha,

ces,

deu,

div,

dzo,

ell,

eng,

spa,

est,

fas,

fan,

ful,

fin,

fij,

fao,

fra,

gle,

grn,

glv,

heb,

hin,

hrv,

hat,

hun,

hye,

ind,

isl,

ita,

jpn,

kat,

kon,

kaz,

kal,

khm,

kor,

kur,

kir,

lat,

ltz,

lin,

lao,

lit,

lub,

lav,

mlg,

mah,

mri,

mkd,

msa,

mlt,

mya,

nob,

nep,

nld,

nno,

nor,

nbl,

nya,

pan,

pol,

pus,

por,

rar,

roh,

rup,

ron,

rus,

kin,

sag,

sin,

slk,

smo,

sna,

som,

sqi,

srp,

ssw,

swe,

swa,

tam,

tgk,

tha,

tir,

tig,

zho,

unmapped_value

Example:

"eng"

data.preferred_language.source_value

Example:

"en_US"

data.ethnicity

object

The employee ethnicity

Show child attributes

data.ethnicity.value

enum<string> | null

Available options:

white,

black_or_african_american,

asian,

hispanic_or_latino,

american_indian_or_alaska_native,

native_hawaiian_or_pacific_islander,

two_or_more_races,

not_disclosed,

other,

unmapped_value

data.ethnicity.source_value

Example:

"white"

data.date_of_birth

string | null

The employee date_of_birth

Example:

"1990-01-01T00:00.000Z"

data.birthday

string | null

The employee birthday

Example:

"2021-01-01T00:00:00Z"

data.marital_status

object

The employee marital status

Show child attributes

data.marital_status.value

enum<string> | null

Available options:

single,

married,

common_law,

divorced,

widowed,

domestic_partnership,

separated,

other,

not_disclosed,

unmapped_value

data.marital_status.source_value

Example:

"single"

data.avatar

object

The employee avatar

Show child attributes

data.avatar.url

string | null

data.avatar.base64

string | null

Example:

"https://example.com/avatar.png"

data.hire_date

string | null

The employee hire date

Example:

"2021-01-01T00:00.000Z"

data.start_date

string | null

deprecated

The employee start date

Example:

"2021-01-01T00:00.000Z"

data.tenure

number | null

The employee tenure

Example:

2

data.work_anniversary

string | null

The employee work anniversary

Example:

"2021-01-01T00:00:00Z"

data.employment_type

object

deprecated

The employee employment type

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:

"full_time"

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

object

The employee employment status

Show child attributes

data.employment_status.value

enum<string> | null

Available options:

active,

pending,

terminated,

leave,

inactive,

unknown,

unmapped_value

data.employment_status.source_value

Example:

"active"

data.termination_date

string | null

The employee termination date

Example:

"2021-01-01T00:00:00Z"

data.company_name

string | null

deprecated

The employee company name

Example:

"Example Corp"

data.company_id

string | null

The employee company id

Example:

"1234567890"

data.citizenships

object[] | null

The citizenships of the Employee

Show child attributes

data.citizenships.value

enum<string> | null

The ISO3166-1 Alpha2 Code of the Country

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

unmapped_value

Example:

"US"

data.citizenships.source_value

data.home_location

object

The employee home location

Show child attributes

data.home_location.id

string | null

Unique identifier

Example:

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

data.home_location.remote_id

string | null

Provider's unique identifier

Example:

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

data.home_location.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.home_location.employee_id

string | null

The employee ID

Example:

"1687-3"

data.home_location.remote_employee_id

string | null

Provider's unique identifier of the employee

Example:

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

data.home_location.name

string | null

The name of the location

Example:

"Woolsthorpe Manor"

data.home_location.phone_number

string | null

The phone number of the location

Example:

"[phone]"

data.home_location.street_1

string | null

The first line of the address

Example:

"Water Lane"

data.home_location.street_2

string | null

The second line of the address

Example:

"Woolsthorpe by Colsterworth"

data.home_location.city

string | null

The city where the location is situated

Example:

"Grantham"

data.home_location.state

string | null

The state where the location is situated

Example:

"Lincolnshire"

data.home_location.zip_code

string | null

The ZIP code/Postal code of the location

Example:

"NG33 5NR"

data.home_location.country

object

The country code

Show child attributes

data.home_location.country.value

enum<string> | null

The ISO3166-1 Alpha2 Code of the Country

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

unmapped_value

Example:

"US"

data.home_location.country.source_value

data.home_location.location_type

object

The location type

Show child attributes

data.home_location.location_type.value

enum<string> | null

Available options:

home,

work,

unmapped_value

data.home_location.location_type.source_value

Example:

"work"

data.home_location.created_at

string | null

The created_at date

Example:

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

data.home_location.updated_at

string | null

The updated_at date

Example:

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

data.work_location

object

The employee work location

Show child attributes

data.work_location.id

string | null

Unique identifier

Example:

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

data.work_location.remote_id

string | null

Provider's unique identifier

Example:

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

data.work_location.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.work_location.employee_id

string | null

The employee ID

Example:

"1687-3"

data.work_location.remote_employee_id

string | null

Provider's unique identifier of the employee

Example:

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

data.work_location.name

string | null

The name of the location

Example:

"Woolsthorpe Manor"

data.work_location.phone_number

string | null

The phone number of the location

Example:

"[phone]"

data.work_location.street_1

string | null

The first line of the address

Example:

"Water Lane"

data.work_location.street_2

string | null

The second line of the address

Example:

"Woolsthorpe by Colsterworth"

data.work_location.city

string | null

The city where the location is situated

Example:

"Grantham"

data.work_location.state

string | null

The state where the location is situated

Example:

"Lincolnshire"

data.work_location.zip_code

string | null

The ZIP code/Postal code of the location

Example:

"NG33 5NR"

data.work_location.country

object

The country code

Show child attributes

data.work_location.country.value

enum<string> | null

The ISO3166-1 Alpha2 Code of the Country

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

unmapped_value

Example:

"US"

data.work_location.country.source_value

data.work_location.location_type

object

The location type

Show child attributes

data.work_location.location_type.value

enum<string> | null

Available options:

home,

work,

unmapped_value

data.work_location.location_type.source_value

Example:

"work"

data.work_location.created_at

string | null

The created_at date

Example:

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

data.work_location.updated_at

string | null

The updated_at date

Example:

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

data.company

object

The employee company

Show child attributes

data.company.id

string | null

Unique identifier

Example:

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

data.company.remote_id

string | null

Provider's unique identifier

Example:

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

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

string | null

The name of the company

Example:

"StackOne Technologies PLC"

data.company.display_name

string | null

The display name of the company

Example:

"StackOne"

data.company.created_at

string | null

The created_at date

Example:

"2023-02-23T00:00:00.000Z"

data.company.updated_at

string | null

The updated_at date

Example:

"2024-02-23T00:00:00.000Z"

data.employments

object[] | null

The employee employments

Show child attributes

data.employments.id

string | null

Unique identifier

Example:

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

data.employments.remote_id

string | null

Provider's unique identifier

Example:

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

data.employments.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.employments.employee_id

string | null

The employee ID associated with this employment

Example:

"1687-3"

data.employments.remote_employee_id

string | null

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

Example:

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

data.employments.job_title

string | null

deprecated

The job title of the employee

Example:

"Software Engineer"

data.employments.pay_rate

string | null

The pay rate for the employee

Example:

"40.00"

data.employments.pay_period

object

The pay period

Show child attributes

data.employments.pay_period.value

enum<string> | null

Available options:

hour,

day,

week,

every_two_weeks,

month,

quarter,

every_six_months,

year,

unmapped_value

data.employments.pay_period.source_value

Example:

"monthly"

data.employments.pay_frequency

object

The pay frequency

Show child attributes

data.employments.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.employments.pay_frequency.source_value

Example:

"hourly"

data.employments.pay_currency

string | null

The currency used for pay

Example:

"USD"

data.employments.effective_date

string | null

The effective date of the employment contract

Example:

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

data.employments.employment_type

object

deprecated

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

Show child attributes

data.employments.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.employments.employment_type.source_value

Example:

"permanent"

data.employments.employment_contract_type

object

deprecated

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

Show child attributes

data.employments.employment_contract_type.value

enum<string> | null

Available options:

full_time,

shifts,

part_time,

unmapped_value

data.employments.employment_contract_type.source_value

Example:

"full_time"

data.employments.time_worked

string | null

The time worked for the employee in ISO 8601 duration format

Example:

"P0Y0M0DT8H0M0S"

data.employments.created_at

string | null

The created_at date

Example:

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

data.employments.updated_at

string | null

The updated_at date

Example:

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

data.employments.start_date

string | null

The start_date of employment

Example:

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

data.employments.end_date

string | null

The end_date of employment

Example:

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

data.employments.active

boolean | null

The employment active status

Example:

true

data.employments.department

object

The employee department

Show child attributes

data.employments.department.id

string | null

Unique identifier

Example:

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

data.employments.department.remote_id

string | null

Provider's unique identifier

Example:

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

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

string | null

The name of the group

Example:

"Engineering"

data.employments.department.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.employments.department.remote_parent_ids

string[] | null

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

Example:

["652434", "6437241"]

data.employments.department.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.employments.department.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.employments.department.type

object

The type of the group

Show child attributes

data.employments.department.type.value

enum<string> | null

Available options:

workspace,

team,

department,

group,

organization,

unmapped_value,

cost_center

Example:

"team"

data.employments.department.type.source_value

data.employments.cost_center

object

deprecated

The employee cost_center

Show child attributes

data.employments.cost_center.id

string | null

Unique identifier

Example:

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

data.employments.cost_center.remote_id

string | null

Provider's unique identifier

Example:

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

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

string | null

The name of the group

Example:

"Engineering"

data.employments.cost_center.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.employments.cost_center.remote_parent_ids

string[] | null

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

Example:

["652434", "6437241"]

data.employments.cost_center.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.employments.cost_center.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.employments.cost_center.type

object

The type of the group

Show child attributes

data.employments.cost_center.type.value

enum<string> | null

Available options:

workspace,

team,

department,

group,

organization,

unmapped_value,

cost_center

Example:

"team"

data.employments.cost_center.type.source_value

data.employments.cost_centers

object[] | null

The employee cost_centers

Show child attributes

data.employments.cost_centers.id

string | null

Unique identifier

Example:

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

data.employments.cost_centers.remote_id

string | null

Provider's unique identifier

Example:

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

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

string | null

The name of the group

Example:

"Engineering"

data.employments.cost_centers.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.employments.cost_centers.remote_parent_ids

string[] | null

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

Example:

["652434", "6437241"]

data.employments.cost_centers.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.employments.cost_centers.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.employments.cost_centers.distribution_percentage

number | null

The distribution percentage for cost_center

Example:

85

data.employments.cost_centers.type

object

The type of the group

Show child attributes

data.employments.cost_centers.type.value

enum<string> | null

Available options:

workspace,

team,

department,

group,

organization,

unmapped_value,

cost_center

Example:

"team"

data.employments.cost_centers.type.source_value

data.employments.division

object

The employee division

Show child attributes

data.employments.division.id

string | null

Unique identifier

Example:

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

data.employments.division.remote_id

string | null

Provider's unique identifier

Example:

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

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

string | null

The name of the group

Example:

"Engineering"

data.employments.division.parent_ids

string[] | null

The list of parent group ids of the given group

Example:

["cxIQNjUyNDM0", "cxIQNjQzNzI0MQ"]

data.employments.division.remote_parent_ids

string[] | null

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

Example:

["652434", "6437241"]

data.employments.division.owner_ids

string[] | null

The list of group owner ids of the given group

Example:

["cxIQNjUyEDM0", "cxIQNjQzNzA0MQ"]

data.employments.division.remote_owner_ids

string[] | null

The list of remote group owner ids of the given group

Example:

["475364", "4327652"]

data.employments.division.type

object

The type of the group

Show child attributes

data.employments.division.type.value

enum<string> | null

Available options:

workspace,

team,

department,

group,

organization,

unmapped_value,

cost_center

Example:

"team"

data.employments.division.type.source_value

data.employments.job

object

The job of employee

Show child attributes

data.employments.job.id

string | null

Unique identifier

Example:

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

data.employments.job.remote_id

string | null

Provider's unique identifier

Example:

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

data.employments.job.title

string | null

Title of the job

Example:

"Software Engineer"

data.employments.job.description

object

The employee job description

Show child attributes

data.employments.job.description.text

string | null

Example:

"Testing the laws of motion"

data.employments.job.owner_id

string | null

The owner_id of the job

Example:

"5356"

data.employments.job.parent_id

string | null

The parent_id of the job

Example:

"7577"

data.employments.type

object

The type of employment

Show child attributes

data.employments.type.id

string | null

Unique identifier

Example:

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

data.employments.type.remote_id

string | null

Provider's unique identifier

Example:

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

data.employments.type.label

string | null

The label of the employment type

Example:

"Permanent"

data.employments.type.type

object

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

Show child attributes

data.employments.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.employments.type.type.source_value

Example:

"permanent"

data.employments.contract_type

object

The employment work schedule type

Show child attributes

data.employments.contract_type.id

string | null

Unique identifier

Example:

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

data.employments.contract_type.remote_id

string | null

Provider's unique identifier

Example:

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

data.employments.contract_type.label

string | null

The label of the employment type

Example:

"Full-Time"

data.employments.contract_type.contract_type

object

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

Show child attributes

data.employments.contract_type.contract_type.value

enum<string> | null

Available options:

full_time,

shifts,

part_time,

unmapped_value

data.employments.contract_type.contract_type.source_value

Example:

"full_time"

data.employments.manager

object[] | null

The employee manager

Show child attributes

data.employments.manager.id

string | null

Unique identifier

Example:

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

data.employments.manager.remote_id

string | null

Provider's unique identifier

Example:

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

data.employments.manager.role

object

The role of manager

Show child attributes

data.employments.manager.role.id

string | null

Unique identifier

Example:

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

data.employments.manager.role.remote_id

string | null

Provider's unique identifier

Example:

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

data.employments.manager.role.label

string | null

The label of the role type

Example:

"Admin"

data.employments.manager.role.role_type

object

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

Show child attributes

Example:

"admin"

data.custom_fields

object[] | null

The employee custom fields

Show child attributes

data.custom_fields.id

string | null

Unique identifier

Example:

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

data.custom_fields.remote_id

string | null

Provider's unique identifier

Example:

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

data.custom_fields.name

string | null

The name of the custom field.

Example:

"Training Completion Status"

data.custom_fields.value

The value associated with the custom field.

Example:

"Completed"

data.custom_fields.value_id

string | null

The unique identifier for the value of the custom field.

Example:

"value_456"

data.custom_fields.remote_value_id

string | null

Provider's unique identifier for the value of the custom field.

Example:

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

data.benefits

object[] | null

Current benefits of the employee

Show child attributes

data.benefits.id

string | null

Unique identifier

Example:

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

data.benefits.remote_id

string | null

Provider's unique identifier

Example:

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

data.benefits.name

string | null

The name of the benefit

Example:

"Health Insurance"

data.benefits.benefit_type

object

The type of the benefit

Show child attributes

data.benefits.benefit_type.value

enum<string> | null

The type of the benefit

Available options:

retirement_savings,

health_savings,

other,

health_insurance,

insurance,

unmapped_value

data.benefits.benefit_type.source_value

data.benefits.provider

string | null

The provider of the benefit

Example:

"Aetna"

data.benefits.description

string | null

The description of the benefit

Example:

"Health insurance for employees"

data.benefits.created_at

string | null

The date and time the benefit was created

Example:

"2021-01-01T00:00:00Z"

data.benefits.updated_at

string | null

The date and time the benefit was last updated

Example:

"2021-01-01T00:00:00Z"

data.employee_number

string | null

The assigned employee number

Example:

"125"

data.national_identity_number

object

deprecated

The national identity number

Show child attributes

data.national_identity_number.value

string | null

Example:

"123456789"

data.national_identity_number.type

object

Show child attributes

data.national_identity_number.type.value

enum<string> | null

The type of the national identity number

Available options:

ssn,

nin,

sin,

nid,

pin,

pn,

umcn,

pic,

ric,

idnum,

cid,

nidnr,

pan,

aadhaar,

epic,

ptn,

itin,

tin,

uprc,

pcode,

ssi,

cedula,

passport,

voterid,

ntin,

bn,

fnr,

mva,

civil_id,

cnic,

nric,

fin,

uen,

registrationnumber,

nic,

personnummer,

ahv,

id,

eid,

va,

pid,

nrt,

nipt,

cbu,

cuit,

dni,

businessid,

vnr,

abn,

acn,

tfn,

jmbg,

bis,

insz,

nn,

egn,

pnf,

vat,

cnpj,

unp,

gst,

pst,

qst,

ni,

dic,

rc,

uid,

rut,

uscc,

cpf,

cpj,

cr,

stnr,

svnr,

ncf,

rnc,

nif,

ci,

ik,

kmkr,

registrikood,

tn,

ruc,

nit,

alv,

hetu,

ytunnus,

vn,

utr,

nifp,

amka,

cui,

nir,

siren,

siret,

tva,

oib,

hkid,

anum,

kennitala,

vsk,

npwp,

pps,

gstin,

idnr,

hr,

aic,

codicefiscale,

iva,

peid,

asmens,

pvm,

ctps,

vrn,

vtk,

int,

tk,

pas,

rne,

rg,

nci,

crnm,

pis,

insee,

tax,

mpf,

epfo,

esi,

pran,

uan,

idk,

bsn,

mid,

sss,

nie,

nss,

arc,

curp,

imss,

rfc,

ein,

other,

unknown

Example:

"ssn"

data.national_identity_number.type.source_value

data.national_identity_number.country

object

The country code

Show child attributes

data.national_identity_number.country.value

enum<string> | null

The ISO3166-1 Alpha2 Code of the Country

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

unmapped_value

Example:

"US"

data.national_identity_number.country.source_value

data.national_identity_numbers

object[] | null

The national identity numbers

Show child attributes

data.national_identity_numbers.value

string | null

Example:

"123456789"

data.national_identity_numbers.type

object

Show child attributes

data.national_identity_numbers.type.value

enum<string> | null

The type of the national identity number

Available options:

ssn,

nin,

sin,

nid,

pin,

pn,

umcn,

pic,

ric,

idnum,

cid,

nidnr,

pan,

aadhaar,

epic,

ptn,

itin,

tin,

uprc,

pcode,

ssi,

cedula,

passport,

voterid,

ntin,

bn,

fnr,

mva,

civil_id,

cnic,

nric,

fin,

uen,

registrationnumber,

nic,

personnummer,

ahv,

id,

eid,

va,

pid,

nrt,

nipt,

cbu,

cuit,

dni,

businessid,

vnr,

abn,

acn,

tfn,

jmbg,

bis,

insz,

nn,

egn,

pnf,

vat,

cnpj,

unp,

gst,

pst,

qst,

ni,

dic,

rc,

uid,

rut,

uscc,

cpf,

cpj,

cr,

stnr,

svnr,

ncf,

rnc,

nif,

ci,

ik,

kmkr,

registrikood,

tn,

ruc,

nit,

alv,

hetu,

ytunnus,

vn,

utr,

nifp,

amka,

cui,

nir,

siren,

siret,

tva,

oib,

hkid,

anum,

kennitala,

vsk,

npwp,

pps,

gstin,

idnr,

hr,

aic,

codicefiscale,

iva,

peid,

asmens,

pvm,

ctps,

vrn,

vtk,

int,

tk,

pas,

rne,

rg,

nci,

crnm,

pis,

insee,

tax,

mpf,

epfo,

esi,

pran,

uan,

idk,

bsn,

mid,

sss,

nie,

nss,

arc,

curp,

imss,

rfc,

ein,

other,

unknown

Example:

"ssn"

data.national_identity_numbers.type.source_value

data.national_identity_numbers.country

object

The country code

Show child attributes

data.national_identity_numbers.country.value

enum<string> | null

The ISO3166-1 Alpha2 Code of the Country

Available options:

AF,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

HR,

CU,

CW,

CY,

CZ,

CI,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RO,

RU,

RW,

RE,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

US,

UM,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW,

unmapped_value

Example:

"US"

data.national_identity_numbers.country.source_value

data.skills

object[] | null

The employee skills

Show child attributes

data.skills.id

string | null

The ID associated with this skill

Example:

"16873-IT345"

data.skills.remote_id

string | null

Provider's unique identifier

Example:

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

data.skills.name

string | null

The name associated with this skill

Example:

"Information-Technology"

data.skills.active

boolean | null

Whether the skill is active and therefore available for use

Example:

true

data.skills.language

object

The language associated with this skill

Show child attributes

data.skills.language.value

enum<string> | null

The Locale Code of the language

Available options:

ar_AR,

aa_ER,

af_NA,

af_ZA,

am_ET,

ar_AE,

ar_BH,

ar_DJ,

ar_DZ,

ar_EG,

ar_ER,

ar_IQ,

ar_JO,

ar_KM,

ar_KW,

ar_LB,

ar_LY,

ar_MA,

ar_MR,

ar_OM,

ar_PS,

ar_QA,

ar_SA,

ar_SD,

ar_SY,

ar_TD,

ar_TN,

ar_YE,

ay_BO,

ay_PE,

az_AZ,

az_IR,

be_BY,

bg_BG,

bi_VU,

bn_BD,

bn_IN,

bs_BA,

bs-ME,

byn_ER,

ca_AD,

ca_ES,

ca_FR,

ca_IT,

ch_GU,

cs_CZ,

da_DK,

de_AT,

de_BE,

de_CH,

de_DE,

de_LI,

de_LU,

de_VA,

de_MV,

dv_MV,

dz_BT,

el_CY,

el_GR,

en_AG,

en_AI,

en_AS,

en_AU,

en_BB,

en_BE,

en_BM,

en_BS,

en_BW,

en_BZ,

en_CA,

en_CC,

en_CK,

en_CM,

en_CW,

en_CX,

en_DG,

en_DM,

en_ER,

en_FJ,

en_FK,

en_FM,

en_GB,

en_GD,

en_GG,

en_GH,

en_GI,

en_GM,

en_GS,

en_GU,

en_GY,

en_HK,

en_IE,

en_IM,

en_IN,

en_IO,

en_JE,

en_JM,

en_KE,

en_KI,

en_KN,

en_KY,

en_LC,

en_LR,

en_LS,

en_MF,

en_MG,

en_MH,

en_MO,

en_MP,

en_MS,

en_MT,

en_MU,

en_MW,

en_MY,

en_NA,

en_NF,

en_NG,

en_NL,

en_NR,

en_NU,

en_NZ,

en_PG,

en_PH,

en_PK,

en_PN,

en_PR,

en_PW,

en_RW,

en_SB,

en_SC,

en_SD,

en_SG,

en_SH,

en_SL,

en_SS,

en_SX,

en_SZ,

en_TC,

en_TK,

en_TO,

en_TT,

en_TV,

en_TZ,

en_UG,

en_UM,

en_US,

en_VC,

en_VG,

en_VI,

en_VU,

en_WS,

en_ZA,

en_ZM,

en_ZW,

es_AR,

es_BO,

es_BZ,

es_CL,

es_CO,

es_CR,

es_CU,

es_DO,

es_EA,

es_EC,

es_EH,

es_ES,

es_GQ,

es_GT,

es_HN,

es_IC,

es_LA,

es_MX,

es_NI,

es_PA,

es_PE,

es_PH,

es_PR,

es_PY,

es_SV,

es_US,

es_UY,

es_VE,

et_EE,

fa_AF,

fa_IR,

fan_GA,

ff_CM,

ff_GN,

ff_MR,

ff_SN,

ff_BF,

fi_FI,

fj_FJ,

fo_FO,

fr_BE,

fr_BF,

fr_BI,

fr_BJ,

fr_BL,

fr_CA,

fr_CD,

fr_CF,

fr_CG,

fr_CH,

fr_CI,

fr_CM,

fr_DJ,

fr_DZ,

fr_FR,

fr_GA,

fr_GF,

fr_GG,

fr_GN,

fr_GP,

fr_GQ,

fr_HT,

fr_KM,

fr_JE,

fr_LU,

fr_LB,

fr_MA,

fr_MC,

fr_MF,

fr_MG,

fr_ML,

fr_MQ,

fr_MR,

fr_MU,

fr_NC,

fr_NE,

fr_PF,

fr_PM,

fr_RE,

fr_RW,

fr_SC,

fr_SN,

fr_SY,

fr_TD,

fr_TF,

fr_TG,

fr_TN,

fr_VU,

fr_VA,

fr_WF,

fr_YT,

ga_IE,

gn_PY,

gn_AR,

gu_IN,

gv_IM,

he_IL,

hi_IN,

hr_BA,

hr_HR,

hr_ME,

ht_HT,

hu_HU,

hy_AM,

hy_CY,

id_ID,

is_IS,

it_CH,

it_IT,

it_SM,

it_VA,

ja_JP,

ka_GE,

kg_CD,

kk_KZ,

kl_GL,

km_KH,

ko_KP,

ko_KR,

ku_IQ,

ky_KG,

la_VA,

lb_LU,

ln_AO,

ln_CD,

ln_CF,

ln_CG,

lo_LA,

lt_LT,

lu_CD,

lv_LV,

mg_MG,

mh_MH,

mi_NZ,

mk_MK,

mn_MN,

mr_IN,

ms_BN,

ms_MY,

ms_SG,

mt_MT,

my_MM,

nb_NO,

nb_BV,

nb_ZW,

ne_NP,

nl_AW,

nl_BE,

nl_BQ,

nl_CW,

nl_NL,

nl_SR,

nl_SX,

nl_MF,

nn_NO,

nn_BV,

no_NO,

no_BV,

no_SJ,

nr_ZA,

ny_MW,

pa_IN,

pa_PK,

pl_PL,

ps_AF,

pt_AO,

pt_BR,

pt_CH,

pt_CV,

pt_GQ,

pt_GW,

pt_LU,

pt_MO,

pt_MZ,

pt_PT,

pt_ST,

pt_TL,

qu_BO,

qu_EC,

qu_PE,

rar_CK,

rm_CH,

rup_MK,

ro_MD,

ro_RO,

ru_BY,

ru_KG,

ru_KZ,

ru_MD,

ru_RU,

ru_UA,

ru_AQ,

ru_TJ,

ru_TM,

ru_UZ,

rw_RW,

se_SE,

sg_CF,

si_LK,

sk_SK,

sl_SI,

sm_AS,

sm_WS,

sn_ZW,

so_DJ,

so_ET,

so_KE,

so_SO,

sq_AL,

sq_ME,

sq_XK,

sr_BA,

sr_ME,

sr_RS,

sr_XK,

ss_SZ,

ss_ZA,

sv_AX,

sv_FI,

sv_SE,

sw_KE,

sw_TZ,

sw_UG,

sw_CD,

ta_IN,

ta_MY,

ta_SG,

ta_LK,

te_IN,

tg_TJ,

th_TH,

ti_ER,

ti_ET,

tig_ER,

tk_TM,

tk_AF,

tn_BW,

tn_ZA,

to_TO,

tr_CY,

tr_TR,

ts_ZA,

uk_UA,

ur_IN,

ur_PK,

uz_AF,

uz_UZ,

ve_ZA,

vi_VN,

xh_ZA,

zh_CN,

zh_HK,

zh_MO,

zh_SG,

zh_TW,

zu_ZA

Example:

"en_GB"

data.skills.language.source_value

data.skills.maximum_proficiency

object

The proficiency level of the skill

Show child attributes

data.skills.maximum_proficiency.id

string | null

Unique identifier

Example:

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

data.skills.maximum_proficiency.remote_id

string | null

Provider's unique identifier

Example:

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

data.skills.maximum_proficiency.name

string | null

The name associated with this proficiency

Example:

"Expert"

data.skills.maximum_proficiency.value

enum<string> | null

Available options:

1,

2,

3,

4,

5

data.skills.maximum_proficiency.source_value

data.skills.minimum_proficiency

object

The proficiency level of the skill

Show child attributes

data.skills.minimum_proficiency.id

string | null

Unique identifier

Example:

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

data.skills.minimum_proficiency.remote_id

string | null

Provider's unique identifier

Example:

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

data.skills.minimum_proficiency.name

string | null

The name associated with this proficiency

Example:

"Expert"

data.skills.minimum_proficiency.value

enum<string> | null

Available options:

1,

2,

3,

4,

5

data.skills.minimum_proficiency.source_value

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"

next_page

string | null

deprecated

next

string | null

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

string | null

raw.response

object | null