Taxonomy data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
typeenumNothe kind of taxonomy item: skill, knowledge, competence, ability, certification or role/occupation Values: SKILL, KNOWLEDGE, COMPETENCE, ABILITY, CERTIFICATION, ROLE, HOLIDAY, LEAVE
namestringNothe preferred label of the skill/role
descriptionstringNo
domainstringNo1st-level grouping (broadest)
categorystringNo2nd-level grouping
subcategorystringNo3rd-level grouping
parent_idstringNoid of the parent taxonomy item, for providers exposing arbitrary-depth trees
alternative_namesstring[]Nosynonyms / alternative labels
urlstringNoexternal reference URL for this item
role_idsstring[]Noids of hris_taxonomy items of type ROLE that this skill relates to
is_activebooleanNo

TypeScript

TypeScript
export type HrisTaxonomy = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	type?: 'SKILL' | 'KNOWLEDGE' | 'COMPETENCE' | 'ABILITY' | 'CERTIFICATION' | 'ROLE' | 'HOLIDAY' | 'LEAVE'; // the kind of taxonomy item: skill, knowledge, competence, ability, certification or role/occupation
	name?: string; // the preferred label of the skill/role
	description?: string;
	domain?: string; // 1st-level grouping (broadest)
	category?: string; // 2nd-level grouping
	subcategory?: string; // 3rd-level grouping
	parent_id?: string; // id of the parent taxonomy item, for providers exposing arbitrary-depth trees
	alternative_names?: string[]; // synonyms / alternative labels
	url?: string; // external reference URL for this item
	role_ids?: string[]; // ids of hris_taxonomy items of type ROLE that this skill relates to
	is_active?: boolean;
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodHrisTaxonomy = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	type: z.enum("SKILL", "KNOWLEDGE", "COMPETENCE", "ABILITY", "CERTIFICATION", "ROLE", "HOLIDAY", "LEAVE").optional().describe("the kind of taxonomy item: skill, knowledge, competence, ability, certification or role/occupation"),
	name: z.string().optional().describe("the preferred label of the skill/role"),
	description: z.string().optional(),
	domain: z.string().optional().describe("1st-level grouping (broadest)"),
	category: z.string().optional().describe("2nd-level grouping"),
	subcategory: z.string().optional().describe("3rd-level grouping"),
	parent_id: z.string().optional().describe("id of the parent taxonomy item, for providers exposing arbitrary-depth trees"),
	alternative_names: z.array().optional().describe("synonyms / alternative labels"),
	url: z.string().optional().describe("external reference URL for this item"),
	role_ids: z.array().optional().describe("ids of hris_taxonomy items of type ROLE that this skill relates to"),
	is_active: z.boolean().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class HrisTaxonomyType(str, Enum):
	SKILL = 'SKILL'
	KNOWLEDGE = 'KNOWLEDGE'
	COMPETENCE = 'COMPETENCE'
	ABILITY = 'ABILITY'
	CERTIFICATION = 'CERTIFICATION'
	ROLE = 'ROLE'
	HOLIDAY = 'HOLIDAY'
	LEAVE = 'LEAVE'

@dataclasses.dataclass
class HrisTaxonomy:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""the kind of taxonomy item: skill, knowledge, competence, ability, certification or role/occupation"""
	type: Optional[HrisTaxonomyType]
	"""the preferred label of the skill/role"""
	name: Optional[str]
	description: Optional[str]
	"""1st-level grouping (broadest)"""
	domain: Optional[str]
	"""2nd-level grouping"""
	category: Optional[str]
	"""3rd-level grouping"""
	subcategory: Optional[str]
	"""id of the parent taxonomy item, for providers exposing arbitrary-depth trees"""
	parent_id: Optional[str]
	"""synonyms / alternative labels"""
	alternative_names: Optional[List[List[str]]]
	"""external reference URL for this item"""
	url: Optional[str]
	"""ids of hris_taxonomy items of type ROLE that this skill relates to"""
	role_ids: Optional[List[List[str]]]
	is_active: Optional[bool]
Are we missing anything? Let us know
Was this page helpful?