--- title: "Job data model" url: "https://docs.unified.to/hris/job/model" description: "The Job data model object in Unified's Job API: 14 fields, including created_at, updated_at and name, with types and enum values." --- # Job data model View field support, webhooks, and list parameters for each integration on the [Supported Integrations](https://docs.unified.to/hris/integrations.md) page. | Field | Type | Required | Description | | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | id | string | No | | | created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | name | string | No | the job or position title | | description | string | No | | | code | string | No | the integration's job code or position number, when it differs from id | | is\_active | boolean | No | | | employment\_type | enum | No | Values: FULL\_TIME, PART\_TIME, CONTRACTOR, INTERN, CONSULTANT, VOLUNTEER, CASUAL, SEASONAL, FREELANCE, OTHER | | company\_id | string | No | (reference to HrisCompany) | | groups | [HrisGroup](https://docs.unified.to/hris/job/model.md#HrisGroup)\[\] | No | the groups (departments, teams, organizations) this job belongs to. May not have all of the Group fields present, but should have id and name | | groups\[\].id | string | No | | | groups\[\].created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | groups\[\].updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | groups\[\].name | string | No | | | groups\[\].description | string | No | | | groups\[\].parent\_id | string | No | | | groups\[\].type | enum | No | Values: TEAM, GROUP, DEPARTMENT, DIVISION, BUSINESS\_UNIT, BRANCH, SUB\_DEPARTMENT, PAY\_GROUP | | groups\[\].user\_ids | string\[\] | No | (reference to HrisEmployee) | | groups\[\].manager\_ids | string\[\] | No | | | groups\[\].is\_active | boolean | No | | | groups\[\].company\_id | string | No | (reference to HrisCompany) | | groups\[\].pay\_frequency | enum | No | pay cycle when type is PAY\_GROUP Values: ONE\_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY | | groups\[\].next\_paid\_at | string (date-time) | No | next pay date when type is PAY\_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | locations | [HrisLocation](https://docs.unified.to/hris/job/model.md#HrisLocation)\[\] | No | where this job is worked. May not have all of the Location fields present, but should have id and name | | locations\[\].id | string | No | | | locations\[\].created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | locations\[\].updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | locations\[\].name | string | No | | | locations\[\].description | string | No | | | locations\[\].address | object | No | | | locations\[\].address.address1 | string | No | | | locations\[\].address.address2 | string | No | | | locations\[\].address.city | string | No | | | locations\[\].address.region | string | No | | | locations\[\].address.region\_code | string | No | | | locations\[\].address.postal\_code | string | No | | | locations\[\].address.country | string | No | | | locations\[\].address.country\_code | string | No | ISO 2-digit country code | | locations\[\].parent\_id | string | No | | | locations\[\].external\_identifier | string | No | | | locations\[\].telephones | [HrisTelephone](https://docs.unified.to/hris/job/model.md#HrisTelephone)\[\] | No | | | locations\[\].telephones\[\].telephone | string | Yes | | | locations\[\].telephones\[\].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | locations\[\].timezone | string | No | | | locations\[\].currency | string | No | | | locations\[\].language\_locale | string | No | | | locations\[\].is\_active | boolean | No | | | locations\[\].is\_hq | boolean | No | if this location is the headquarters of the company | | locations\[\].company\_id | string | No | (reference to HrisCompany) | | parent\_id | string | No | the hris\_job this job reports to (position hierarchy) | | users | [HrisEmployee](https://docs.unified.to/hris/job/model.md#HrisEmployee)\[\] | No | the employees currently holding this job. May not have all of the Employee fields present, but should have id and name | | users\[\].id | string | No | | | users\[\].created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].name | string | No | | | users\[\].first\_name | string | No | | | users\[\].last\_name | string | No | | | users\[\].emails | [HrisEmail](https://docs.unified.to/hris/job/model.md#HrisEmail)\[\] | No | | | users\[\].emails\[\].email | string | Yes | | | users\[\].emails\[\].type | enum | No | Values: WORK, HOME, OTHER | | users\[\].title | string | No | | | users\[\].job\_id | string | No | the hris\_job (position) this employee holds; their primary job when they hold more than one | | users\[\].manager\_id | string | No | | | users\[\].employment\_status | enum | No | Values: ACTIVE, INACTIVE | | users\[\].gender | enum | No | Values: MALE, FEMALE, INTERSEX, TRANS, NON\_BINARY | | users\[\].telephones | [HrisTelephone](https://docs.unified.to/hris/job/model.md#HrisTelephone)\[\] | No | | | users\[\].telephones\[\].telephone | string | Yes | | | users\[\].telephones\[\].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | users\[\].date\_of\_birth | string (date-time) | No | YYYYMM/DD | | users\[\].employee\_number | string | No | the company's ID for this employee | | users\[\].hired\_at | string (date-time) | No | The employee's start date (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].terminated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].termination\_reason | string | No | | | users\[\].marital\_status | enum | No | Values: MARRIED, SINGLE | | users\[\].employment\_type | enum | No | Values: FULL\_TIME, PART\_TIME, CONTRACTOR, INTERN, CONSULTANT, VOLUNTEER, CASUAL, SEASONAL, FREELANCE, OTHER | | users\[\].address | object | No | | | users\[\].address.address1 | string | No | | | users\[\].address.address2 | string | No | | | users\[\].address.city | string | No | | | users\[\].address.region | string | No | | | users\[\].address.region\_code | string | No | | | users\[\].address.postal\_code | string | No | | | users\[\].address.country | string | No | | | users\[\].address.country\_code | string | No | ISO 2-digit country code | | users\[\].language\_locale | string | No | | | users\[\].currency | string | No | | | users\[\].timezone | string | No | | | users\[\].image\_url | string | No | This link expires after 1 hour. | | users\[\].company\_id | string | No | (reference to HrisCompany) | | users\[\].pronouns | string | No | | | users\[\].employee\_roles | enum | No | Values: ADMIN, MANAGER, RECRUITER, SALESREP, INTERVIEWER, USER, EMPLOYEE | | users\[\].compensation | [HrisCompensation](https://docs.unified.to/hris/job/model.md#HrisCompensation)\[\] | No | | | users\[\].compensation\[\].type | enum | No | Values: SALARY, BONUS, STOCK\_OPTIONS, EQUITY, OTHER, HOURLY, COMMISSION | | users\[\].compensation\[\].amount | number | No | | | users\[\].compensation\[\].currency | string | No | | | users\[\].compensation\[\].frequency | enum | No | Values: ONE\_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY | | users\[\].compensation\[\].group\_id | string | No | (reference to HrisGroup) | | users\[\].compensation\[\].notes | string | No | | | users\[\].salutation | string | No | Mr. Mrs. Ms. | | users\[\].bio | string | No | | | users\[\].ssn\_sin | string | No | | | users\[\].groups | [HrisGroup](https://docs.unified.to/hris/job/model.md#HrisGroup)\[\] | No | Which groups/teams/units that this employee/user belongs to. May not have all of the Group fields present, but should have id, name, or email. | | users\[\].groups\[\].id | string | No | | | users\[\].groups\[\].created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].groups\[\].updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].groups\[\].name | string | No | | | users\[\].groups\[\].description | string | No | | | users\[\].groups\[\].parent\_id | string | No | | | users\[\].groups\[\].type | enum | No | Values: TEAM, GROUP, DEPARTMENT, DIVISION, BUSINESS\_UNIT, BRANCH, SUB\_DEPARTMENT, PAY\_GROUP | | users\[\].groups\[\].user\_ids | string\[\] | No | (reference to HrisEmployee) | | users\[\].groups\[\].manager\_ids | string\[\] | No | | | users\[\].groups\[\].is\_active | boolean | No | | | users\[\].groups\[\].company\_id | string | No | (reference to HrisCompany) | | users\[\].groups\[\].pay\_frequency | enum | No | pay cycle when type is PAY\_GROUP Values: ONE\_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY | | users\[\].groups\[\].next\_paid\_at | string (date-time) | No | next pay date when type is PAY\_GROUP (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].locations | [HrisLocation](https://docs.unified.to/hris/job/model.md#HrisLocation)\[\] | No | | | users\[\].locations\[\].id | string | No | | | users\[\].locations\[\].created\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].locations\[\].updated\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].locations\[\].name | string | No | | | users\[\].locations\[\].description | string | No | | | users\[\].locations\[\].address | object | No | | | users\[\].locations\[\].address.address1 | string | No | | | users\[\].locations\[\].address.address2 | string | No | | | users\[\].locations\[\].address.city | string | No | | | users\[\].locations\[\].address.region | string | No | | | users\[\].locations\[\].address.region\_code | string | No | | | users\[\].locations\[\].address.postal\_code | string | No | | | users\[\].locations\[\].address.country | string | No | | | users\[\].locations\[\].address.country\_code | string | No | ISO 2-digit country code | | users\[\].locations\[\].parent\_id | string | No | | | users\[\].locations\[\].external\_identifier | string | No | | | users\[\].locations\[\].telephones | [HrisTelephone](https://docs.unified.to/hris/job/model.md#HrisTelephone)\[\] | No | | | users\[\].locations\[\].telephones\[\].telephone | string | Yes | | | users\[\].locations\[\].telephones\[\].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | users\[\].locations\[\].timezone | string | No | | | users\[\].locations\[\].currency | string | No | | | users\[\].locations\[\].language\_locale | string | No | | | users\[\].locations\[\].is\_active | boolean | No | | | users\[\].locations\[\].is\_hq | boolean | No | if this location is the headquarters of the company | | users\[\].locations\[\].company\_id | string | No | (reference to HrisCompany) | | users\[\].metadata | [HrisMetadata](https://docs.unified.to/hris/job/model.md#HrisMetadata)\[\] | No | | | users\[\].metadata\[\].id | string | No | | | users\[\].metadata\[\].value | object | No | | | users\[\].metadata\[\].namespace | string | No | | | users\[\].metadata\[\].format | enum | No | Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL | | users\[\].metadata\[\].extra\_data | object | No | | | users\[\].metadata\[\].slug | string | No | | | users\[\].storage\_quota\_allocated | number | No | | | users\[\].storage\_quota\_used | number | No | | | users\[\].storage\_quota\_available | number | No | | | users\[\].relationships | [HrisEmployeerelationship](https://docs.unified.to/hris/job/model.md#HrisEmployeerelationship)\[\] | No | the employee's personal relationships (eg. emergency contacts, spouse, dependants, ...) | | users\[\].relationships\[\].name | string | No | | | users\[\].relationships\[\].first\_name | string | No | | | users\[\].relationships\[\].last\_name | string | No | | | users\[\].relationships\[\].emails | [HrisEmail](https://docs.unified.to/hris/job/model.md#HrisEmail)\[\] | No | | | users\[\].relationships\[\].emails\[\].email | string | Yes | | | users\[\].relationships\[\].emails\[\].type | enum | No | Values: WORK, HOME, OTHER | | users\[\].relationships\[\].telephones | [HrisTelephone](https://docs.unified.to/hris/job/model.md#HrisTelephone)\[\] | No | | | users\[\].relationships\[\].telephones\[\].telephone | string | Yes | | | users\[\].relationships\[\].telephones\[\].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE | | users\[\].relationships\[\].address | [HrisEmployeerelationship\_address](https://docs.unified.to/hris/job/model.md#HrisEmployeerelationship%5Faddress) | No | | | users\[\].relationships\[\].address.address1 | string | No | | | users\[\].relationships\[\].address.address2 | string | No | | | users\[\].relationships\[\].address.city | string | No | | | users\[\].relationships\[\].address.region | string | No | | | users\[\].relationships\[\].address.region\_code | string | No | | | users\[\].relationships\[\].address.postal\_code | string | No | | | users\[\].relationships\[\].address.country | string | No | | | users\[\].relationships\[\].address.country\_code | string | No | ISO 2-digit country code | | users\[\].relationships\[\].type | enum | No | Values: EMERGENCY, SPOUSE, CHILD, PARENT, SIBLING, FRIEND, OTHER | | users\[\].relationships\[\].is\_dependent | boolean | No | | | users\[\].relationships\[\].is\_beneficiary | boolean | No | | | users\[\].relationships\[\].start\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].relationships\[\].end\_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) | | users\[\].has\_mfa | boolean | No | does the user/employee have multi-factor authentication enabled | | users\[\].timeoff\_days\_total | number | No | Total time off allowance for the current leave period, in days (when reported by the provider) | | users\[\].timeoff\_days\_used | number | No | Time off days used or booked in the current leave period (when reported by the provider) | | users\[\].flsa\_status | enum | No | US Fair Labor Standards Act classification Values: EXEMPT, NON\_EXEMPT, SALARIED\_NONEXEMPT, OWNER | | users\[\].pay\_frequency | enum | No | how often the employee is paid (eg. BIWEEKLY) Values: ONE\_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY | | compensation | [HrisCompensation](https://docs.unified.to/hris/job/model.md#HrisCompensation)\[\] | No | pay attached to the job itself (eg. an hourly rate) | | compensation\[\].type | enum | No | Values: SALARY, BONUS, STOCK\_OPTIONS, EQUITY, OTHER, HOURLY, COMMISSION | | compensation\[\].amount | number | No | | | compensation\[\].currency | string | No | | | compensation\[\].frequency | enum | No | Values: ONE\_TIME, DAY, QUARTER, YEAR, HOUR, MONTH, WEEK, BIWEEKLY, SEMIMONTHLY | | compensation\[\].group\_id | string | No | (reference to HrisGroup) | | compensation\[\].notes | string | No | | ## TypeScript ```typescript export type HrisJob = { 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; // the job or position title description?: string; code?: string; // the integration's job code or position number, when it differs from id is_active?: boolean; employment_type?: 'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'INTERN' | 'CONSULTANT' | 'VOLUNTEER' | 'CASUAL' | 'SEASONAL' | 'FREELANCE' | 'OTHER'; company_id?: string; // (reference to HrisCompany) groups?: []; // the groups (departments, teams, organizations) this job belongs to. May not have all of the Group fields present, but should have id and name locations?: []; // where this job is worked. May not have all of the Location fields present, but should have id and name parent_id?: string; // the hris_job this job reports to (position hierarchy) users?: []; // the employees currently holding this job. May not have all of the Employee fields present, but should have id and name compensation?: []; // pay attached to the job itself (eg. an hourly rate) raw?: any; } ``` ## Zod ```typescript import { z } from 'zod'; export const ZodHrisJob = 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().describe("the job or position title"), description: z.string().optional(), code: z.string().optional().describe("the integration's job code or position number, when it differs from id"), is_active: z.boolean().optional(), employment_type: z.enum("FULL_TIME", "PART_TIME", "CONTRACTOR", "INTERN", "CONSULTANT", "VOLUNTEER", "CASUAL", "SEASONAL", "FREELANCE", "OTHER").optional(), company_id: z.string().optional().describe("(reference to HrisCompany)"), groups: z.array().optional().describe("the groups (departments, teams, organizations) this job belongs to. May not have all of the Group fields present, but should have id and name"), locations: z.array().optional().describe("where this job is worked. May not have all of the Location fields present, but should have id and name"), parent_id: z.string().optional().describe("the hris_job this job reports to (position hierarchy)"), users: z.array().optional().describe("the employees currently holding this job. May not have all of the Employee fields present, but should have id and name"), compensation: z.array().optional().describe("pay attached to the job itself (eg. an hourly rate)"), }); ``` ## Python ```python import dataclasses @dataclasses.dataclass class HrisJobEmployment_type(str, Enum): FULL_TIME = 'FULL_TIME' PART_TIME = 'PART_TIME' CONTRACTOR = 'CONTRACTOR' INTERN = 'INTERN' CONSULTANT = 'CONSULTANT' VOLUNTEER = 'VOLUNTEER' CASUAL = 'CASUAL' SEASONAL = 'SEASONAL' FREELANCE = 'FREELANCE' OTHER = 'OTHER' @dataclasses.dataclass class HrisJob: 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 job or position title""" name: Optional[str] description: Optional[str] """the integration's job code or position number, when it differs from id""" code: Optional[str] is_active: Optional[bool] employment_type: Optional[HrisJobEmployment_type] """(reference to HrisCompany)""" company_id: Optional[str] """the groups (departments, teams, organizations) this job belongs to. May not have all of the Group fields present, but should have id and name""" groups: Optional[PropertyHrisJobGroups] """where this job is worked. May not have all of the Location fields present, but should have id and name""" locations: Optional[PropertyHrisJobLocations] """the hris_job this job reports to (position hierarchy)""" parent_id: Optional[str] """the employees currently holding this job. May not have all of the Employee fields present, but should have id and name""" users: Optional[PropertyHrisJobUsers] """pay attached to the job itself (eg. an hourly rate)""" compensation: Optional[PropertyHrisJobCompensation] ```