Group 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)
namestringNo
descriptionstringNo
parent_idstringNo
typeenumNoValues: TEAM, GROUP, DEPARTMENT, DIVISION, BUSINESS_UNIT, BRANCH, SUB_DEPARTMENT, PAY_GROUP
user_idsstring[]No(reference to HrisEmployee)
manager_idsstring[]No
is_activebooleanNo
company_idstringNo(reference to HrisCompany)
pay_frequencyenumNopay cycle when type is PAY_GROUP Values: ONE_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY
next_paid_atstring (date-time)Nonext pay date when type is PAY_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

TypeScript

TypeScript
export type HrisGroup = {
	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)
	name?: string;
	description?: string;
	parent_id?: string;
	type?: 'TEAM' | 'GROUP' | 'DEPARTMENT' | 'DIVISION' | 'BUSINESS_UNIT' | 'BRANCH' | 'SUB_DEPARTMENT' | 'PAY_GROUP';
	user_ids?: string[]; // (reference to HrisEmployee)
	manager_ids?: string[];
	is_active?: boolean;
	company_id?: string; // (reference to HrisCompany)
	pay_frequency?: 'ONE_TIME' | 'DAY' | 'QUARTER' | 'YEAR' | 'HOUR' | 'MONTH' | 'WEEK' | 'BIWEEKLY' | 'SEMIMONTHLY'; // pay cycle when type is PAY_GROUP
	next_paid_at?: string-time; // next pay date when type is PAY_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodHrisGroup = 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)"),
	name: z.string().optional(),
	description: z.string().optional(),
	parent_id: z.string().optional(),
	type: z.enum("TEAM", "GROUP", "DEPARTMENT", "DIVISION", "BUSINESS_UNIT", "BRANCH", "SUB_DEPARTMENT", "PAY_GROUP").optional(),
	user_ids: z.array().optional().describe("(reference to HrisEmployee)"),
	manager_ids: z.array().optional(),
	is_active: z.boolean().optional(),
	company_id: z.string().optional().describe("(reference to HrisCompany)"),
	pay_frequency: z.enum("ONE_TIME", "DAY", "QUARTER", "YEAR", "HOUR", "MONTH", "WEEK", "BIWEEKLY", "SEMIMONTHLY").optional().describe("pay cycle when type is PAY_GROUP"),
	next_paid_at: z.string-time().optional().describe("next pay date when type is PAY_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class HrisGroupType(str, Enum):
	TEAM = 'TEAM'
	GROUP = 'GROUP'
	DEPARTMENT = 'DEPARTMENT'
	DIVISION = 'DIVISION'
	BUSINESS_UNIT = 'BUSINESS_UNIT'
	BRANCH = 'BRANCH'
	SUB_DEPARTMENT = 'SUB_DEPARTMENT'
	PAY_GROUP = 'PAY_GROUP'

@dataclasses.dataclass
class HrisGroupPay_frequency(str, Enum):
	ONE_TIME = 'ONE_TIME'
	DAY = 'DAY'
	QUARTER = 'QUARTER'
	YEAR = 'YEAR'
	HOUR = 'HOUR'
	MONTH = 'MONTH'
	WEEK = 'WEEK'
	BIWEEKLY = 'BIWEEKLY'
	SEMIMONTHLY = 'SEMIMONTHLY'

@dataclasses.dataclass
class HrisGroup:
	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]
	name: Optional[str]
	description: Optional[str]
	parent_id: Optional[str]
	type: Optional[HrisGroupType]
	"""(reference to HrisEmployee)"""
	user_ids: Optional[List[List[str]]]
	manager_ids: Optional[List[List[str]]]
	is_active: Optional[bool]
	"""(reference to HrisCompany)"""
	company_id: Optional[str]
	"""pay cycle when type is PAY_GROUP"""
	pay_frequency: Optional[HrisGroupPay_frequency]
	"""next pay date when type is PAY_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	next_paid_at: Optional[str]
Are we missing anything? Let us know
Was this page helpful?