Retrieve a taxonomy

GET/hris/{connection_id}/taxonomy/{id}

Parameters

fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection
idstring required
ID of the Taxonomy

Returns

idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
type enum
Valid values:
"SKILL"
"KNOWLEDGE"
"COMPETENCE"
"ABILITY"
"CERTIFICATION"
the kind of taxonomy item: skill, knowledge, competence, ability, certification or role/occupation
namestring
the preferred label of the skill/role
descriptionstring
domainstring
1st-level grouping (broadest)
categorystring
2nd-level grouping
subcategorystring
3rd-level grouping
parent_idstring
id of the parent taxonomy item, for providers exposing arbitrary-depth trees
alternative_namesstring array
synonyms / alternative labels
urlstring
external reference URL for this item
role_idsstring array
ids of hris_taxonomy items of type ROLE that this skill relates to
is_activeboolean
const options = {
  method: 'GET',
  url: 'https://api.unified.to/hris/5de520f96e439b002043d8dc/taxonomy/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?