{"info":{"title":"intelliHR Public API","version":"BETA","description":"You can find developer's guide and more documentation on [https://developers.intellihr.io](https://developers.intellihr.io)","contact":{"name":"Customer Support","email":"support@intellihr.co"},"x-logo":{"url":"https://intellihr.com.au/wp-content/themes/ihr-wpTheme/assets/images/ihr_logo_color.png","altText":"intelliHR logo","href":"https://intellihr.com.au"}},"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","description":"You can generate and delete API keys through your intelliHR portal. API keys should be sent as `Authorization: Bearer <key>`","in":"header","name":"Authorization"}},"schemas":{"business-entities_list":{"type":"object","title":"List Business Entities","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Business Entity","properties":{"type":{"enum":["businessEntities"],"readOnly":true,"type":"string"},"id":{"description":"Business Entity entry unique identifier","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","properties":{"name":{"description":"Name given to this [Business Entity](#tag/Business-Entities). This name would normally be shown to users of the system","example":"Gotham Far SE","type":"string"},"legalName":{"description":"Legal name can be different from the name presented to a user. Usually used for administrative tasks","example":"Gotham Blackgate Isle","type":"string"},"number":{"description":"Legally registered [Business Entity](#tag/Business-Entities) number, e.g. in Australia this might be the ABN, or in America the RN","example":"00 000 000 000","type":"string"},"notes":{"description":"Optional field that can be used to store notes on a [Business Entity](#tag/Business-Entities)","example":"A small notorious isle in the far south east of the city.","type":"string"},"isEnabled":{"$ref":"#/definitions/isEnabled"},"jobCount":{"description":"Number of jobs that have been assigned to this [Business Entity](#tag/Business-Entities)","minimum":0,"type":"integer"},"createdAt":{"$ref":"#/definitions/createdAt"},"updatedAt":{"$ref":"#/definitions/updatedAt"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/business-entities?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/business-entities?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/business-entities?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/business-entities?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/business-entities?limit=1&page=5"}}}]}}},"business-units_list":{"type":"object","title":"List Business Units","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Business Unit","properties":{"type":{"enum":["businessUnits"],"readOnly":true,"type":"string"},"id":{"description":"The identifier string for the [Business Unit](#tag/Business-Units)","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"attributes","properties":{"identifier":{"description":"Optional identifier that can be used for administrative tasks","example":"","type":"string"},"name":{"description":"Name given to this [Business Unit](#tag/Business-Units). This name would normally be shown to users of the system","example":"Engineering","type":"string"},"notes":{"description":"Optional field that can be used to store notes on a [Business Unit](#tag/Business-Units)","example":"","type":"string"},"parentId":{"description":"The identifier string for the parent [Business Unit](#tag/Business-Units)","allOf":[{"$ref":"#/definitions/resourceId"}]},"sortOrder":{"$ref":"#/definitions/sortOrder"},"isEnabled":{"$ref":"#/definitions/isEnabled"},"createdAt":{"$ref":"#/definitions/createdAt"},"updatedAt":{"$ref":"#/definitions/updatedAt"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/business-units?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/business-units?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/business-units?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/business-units?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/business-units?limit=1&page=5"}}}]}}},"countries_list":{"type":"object","title":"List Countries","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Country","properties":{"type":{"readOnly":true,"type":"string","enum":["countries"]},"id":{"description":"The identifier string for the [Country](#tag/Countries)","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","properties":{"name":{"type":"string","description":"The name of the [Country](#tag/Countries), e.g. `Australia`, `United Kingdom` or `Paraguay`","example":"Australia"},"isoCode":{"type":"string","description":"The offical [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) code for this [Country](#tag/Countries)","example":"Australia"},"dialCode":{"type":"string","description":"The official dial code as defined by the [ITU-T](https://en.wikipedia.org/wiki/List_of_country_calling_codes) for this [Country](#tag/Countries)","example":"Australia"},"isCommon":{"type":"boolean","description":"Specifies if this resource is concidered a \"common\" [Country](#tag/Countries) and should appear more prominent for user selection","example":false}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/countries?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/countries?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/countries?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/countries?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/countries?limit=1&page=5"}}}]}}},"form-designs":{"type":"object","title":"Single Training","properties":{"data":{"type":"object","title":"Form Design","properties":{"type":{"type":"string","title":"Data Model type","description":"The name of the data model that is being returned","example":"formDesigns"},"id":{"description":"The identifier string for the form design","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Form Design attributes","properties":{"name":{"type":"string","description":"Name given to this [Form Design](#tag/Form-Designs)","example":"3 month check-in"},"isEnabled":{"allOf":[{"$ref":"#/definitions/isEnabled"}]},"version":{"type":"integer","description":"Version of this [Form Design](#tag/Form-Designs)","example":63},"isCurrent":{"description":"Specifies if this is the most current version of the [Form Design](#tag/Form-Designs)","allOf":[{"$ref":"#/definitions/isEnabled"}]},"triggerOnCompleteFormDesignId":{"description":"If set, this [Form Design](#tag/Form-Designs) will be triggered after completing an instance of the form","allOf":[{"$ref":"#/definitions/resourceId"}]},"createdAt":{"description":"The timestamp the [Form Design](#tag/Form-Designs) was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"description":"The timestamp the [Form Design](#tag/Form-Designs) was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]}}}}}}},"form-designs_list":{"type":"object","title":"List Form Designs","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Form Design","properties":{"type":{"type":"string","title":"Data Model type","description":"The name of the data model that is being returned","example":"formDesigns"},"id":{"description":"The identifier string for the form design","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Form Design attributes","properties":{"name":{"type":"string","description":"Name given to this [Form Design](#tag/Form-Designs)","example":"3 month check-in"},"isEnabled":{"allOf":[{"$ref":"#/definitions/isEnabled"}]},"version":{"type":"integer","description":"Version of this [Form Design](#tag/Form-Designs)","example":63},"isCurrent":{"description":"Specifies if this is the most current version of the [Form Design](#tag/Form-Designs)","allOf":[{"$ref":"#/definitions/isEnabled"}]},"triggerOnCompleteFormDesignId":{"description":"If set, this [Form Design](#tag/Form-Designs) will be triggered after completing an instance of the form","allOf":[{"$ref":"#/definitions/resourceId"}]},"createdAt":{"description":"The timestamp the [Form Design](#tag/Form-Designs) was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"description":"The timestamp the [Form Design](#tag/Form-Designs) was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/form-designs?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/form-designs?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/form-designs?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/form-designs?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/form-designs?limit=1&page=5"}}}]}}},"form-instances":{"type":"object","title":"Get Form Instance","properties":{"data":{"type":"object","title":"Form Instance","properties":{"type":{"type":"string","title":"Data Model type","description":"The name of the data model that is being returned","example":"formInstances"},"id":{"description":"The identifier string for the form instance","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Form Instance attributes","properties":{"accessCode":{"type":"string","description":"Secret code used to complete form without requiring a login","example":"B5fVkvGiVW","pattern":"^([a-zA-Z0-9]{10})$"},"formDesignId":{"description":"Form Design ID","allOf":[{"$ref":"#/definitions/resourceId"}]},"formDesignVersion":{"type":"integer","description":"Version of the form design this [Form Instance](#tag/Form-Instances) was completed against","default":null,"example":1},"issueDate":{"description":"The timestamp the [Form Instance](#tag/Form-Instances) was issues","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"dueDate":{"description":"The timestamp the [Form Instance](#tag/Form-Instances) is due to be completed","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"subjectPersonId":{"description":"The [Person](#tag/People) ID of the subject of this [Form Instance](#tag/Form-Instances)","allOf":[{"$ref":"#/definitions/resourceId"}]},"subjectJobId":{"description":"A [Job](#tag/Jobs) ID belonging to the Subject Person that this [Form Instance](#tag/Form-Instances) relates to","allOf":[{"$ref":"#/definitions/resourceId"}]},"respondentPersonId":{"description":"The [Person](#tag/People) ID of the [Person](#tag/People) filling in the form","allOf":[{"$ref":"#/definitions/resourceId"}]},"hasBeenOpened":{"type":"boolean","description":"A flag to say if the [Form Instnace](#tag/Form-Instances) has been opened","default":false,"example":true},"openedAt":{"description":"The timestamp the [Form Instance](#tag/Form-Instances) was opened","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"hasBeenCompleted":{"type":"boolean","description":"A flag to say if the [Form Instnace](#tag/Form-Instances) has been completed","default":false,"example":false},"completedAt":{"description":"The timestamp the [Form Instance](#tag/Form-Instances) was completed","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"isIgnored":{"type":"boolean","description":"A flag to say if the [Form Instnace](#tag/Form-Instances) was ignored","default":false,"example":false},"ignoredAt":{"description":"The timestamp the [Form Instance](#tag/Form-Instances) was ignored","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"visibleToSubject":{"type":"boolean","description":"A flag to say if the [Form Instnace](#tag/Form-Instances) should be viewable by the subject","default":false,"example":false},"shouldNotifyRespondent":{"type":"boolean","description":"A flag to say if the [Form Instnace](#tag/Form-Instances) will notify the respondent when completed","default":false,"example":false},"createdAt":{"description":"The timestamp the [Form Instnace](#tag/Form-Instances) was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"description":"The timestamp the [Form Instnace](#tag/Form-Instances) was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]}}}}}}},"form-instances_list":{"type":"object","title":"List Form Instances","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Form Instance","properties":{"type":{"type":"string","title":"Data Model type","description":"The name of the data model that is being returned","example":"formInstances"},"id":{"description":"The identifier string for the form instance","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Form Instance attributes","properties":{"accessCode":{"type":"string","description":"Secret code used to complete form without requiring a login","example":"B5fVkvGiVW","pattern":"^([a-zA-Z0-9]{10})$"},"formDesignId":{"description":"Form Design ID","allOf":[{"$ref":"#/definitions/resourceId"}]},"formDesignVersion":{"type":"integer","description":"Version of the form design this [Form Instance](#tag/Form-Instances) was completed against","default":null,"example":1},"issueDate":{"description":"The timestamp the [Form Instance](#tag/Form-Instances) was issues","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"dueDate":{"description":"The timestamp the [Form Instance](#tag/Form-Instances) is due to be completed","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"subjectPersonId":{"description":"The [Person](#tag/People) ID of the subject of this [Form Instance](#tag/Form-Instances)","allOf":[{"$ref":"#/definitions/resourceId"}]},"subjectJobId":{"description":"A [Job](#tag/Jobs) ID belonging to the Subject Person that this [Form Instance](#tag/Form-Instances) relates to","allOf":[{"$ref":"#/definitions/resourceId"}]},"respondentPersonId":{"description":"The [Person](#tag/People) ID of the [Person](#tag/People) filling in the form","allOf":[{"$ref":"#/definitions/resourceId"}]},"hasBeenOpened":{"type":"boolean","description":"A flag to say if the [Form Instnace](#tag/Form-Instances) has been opened","default":false,"example":true},"openedAt":{"description":"The timestamp the [Form Instance](#tag/Form-Instances) was opened","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"hasBeenCompleted":{"type":"boolean","description":"A flag to say if the [Form Instnace](#tag/Form-Instances) has been completed","default":false,"example":false},"completedAt":{"description":"The timestamp the [Form Instance](#tag/Form-Instances) was completed","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"isIgnored":{"type":"boolean","description":"A flag to say if the [Form Instnace](#tag/Form-Instances) was ignored","default":false,"example":false},"ignoredAt":{"description":"The timestamp the [Form Instance](#tag/Form-Instances) was ignored","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"visibleToSubject":{"type":"boolean","description":"A flag to say if the [Form Instnace](#tag/Form-Instances) should be viewable by the subject","default":false,"example":false},"shouldNotifyRespondent":{"type":"boolean","description":"A flag to say if the [Form Instnace](#tag/Form-Instances) will notify the respondent when completed","default":false,"example":false},"createdAt":{"description":"The timestamp the [Form Instnace](#tag/Form-Instances) was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"description":"The timestamp the [Form Instnace](#tag/Form-Instances) was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/form-instances?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/form-instances?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/form-instances?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/form-instances?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/form-instances?limit=1&page=5"}}}]}}},"genders_list":{"type":"object","title":"List Genders","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"gender","properties":{"type":{"readOnly":true,"type":"string","enum":["genders"]},"id":{"description":"The identifier string for the Gender","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"The Attributes Schema","properties":{"name":{"type":"string","description":"Name given to this Gender. Examples include `Male`, `Female` and `Other`.","example":"Female"},"sortOrder":{"allOf":[{"$ref":"#/definitions/sortOrder"}]},"createdAt":{"$ref":"#/definitions/createdAt"},"updatedAt":{"$ref":"#/definitions/updatedAt"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/genders?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/genders?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/genders?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/genders?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/genders?limit=1&page=5"}}}]}}},"jobs":{"type":"object","title":"Single Job","properties":{"data":{"type":"object","title":"Job","properties":{"type":{"type":"string","enum":["jobs"],"readOnly":true},"id":{"description":"The identifier string for the job","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"The Job Data Model Schema","properties":{"startDate":{"example":"2003-02-11T14:00:00+00:00","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"endDate":{"example":"2017-02-11T14:00:00+00:00","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"isEndDateConfirmed":{"type":"boolean","title":"The Is End Date Confirmed Schema","default":false,"example":false},"name":{"type":"string","title":"The Name Schema","example":"Chief Executive Officer","pattern":"^(.*)$"},"businessUnit":{"type":"string","title":"The Business Unit Schema","example":"Executive","pattern":"^(.*)$"},"businessEntity":{"type":"string","title":"The Business Entity Schema","example":"intelliHR - AU","pattern":"^(.*)$"},"status":{"type":"string","title":"The Status Schema","example":"Current Job","pattern":"^(.*)$"},"workType":{"type":"string","title":"The Work Type Schema","example":"Permanent","pattern":"^(.*)$"},"workClass":{"type":"string","title":"The Work Class Schema","example":"Full-Time","pattern":"^(.*)$"},"payGrade":{"type":"string","title":"The Paygrade Schema","example":"Founder","pattern":"^(.*)$"},"fte":{"type":"decimal","title":"The Fte Schema","example":1},"supervisorId":{"description":"The identifier string for the supervisors job","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/resourceId"}]},"currency":{"$ref":"#/definitions/currency"},"recruitmentCost":{"type":"decimal","title":"The Recruitment Cost Schema","example":500},"source":{"type":"string","title":"The Source Schema","example":"Unknown","pattern":"^(.*)$"},"leave":{"type":"array","title":"Leave","description":"An array of Leave entries linked to this [Job](#tag/Jobs)","items":{"$ref":"#/definitions/leave"}},"location":{"type":"object","title":"The Location Schema","properties":{"name":{"type":"string","title":"The Name Schema","example":"Brisbane","pattern":"^(.*)$"},"address":{"type":"string","title":"The Address Schema","example":"Level 28, 345 Queen Street, Brisbane, 4000","pattern":"^(.*)$"}}},"personId":{"description":"The identifier string for the person in this job","allOf":[{"$ref":"#/definitions/resourceId"}]},"createdAt":{"$ref":"#/definitions/createdAt"},"updatedAt":{"$ref":"#/definitions/updatedAt"}}}}}}},"jobs_create":{"type":"object","title":"The Job Data Model Schema","properties":{"businessEntityId":{"description":"The UUIDv4 identifier for the [Business Entity](#tag/Business-Entities).","required":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"businessUnitId":{"description":"The UUIDv4 identifier for the [Business Unit](#tag/Business-Units).","required":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"createdAt":{"$ref":"#/definitions/createdAt"},"currency":{"$ref":"#/definitions/currency"},"endDate":{"example":"2017-02-11T14:00:00+00:00","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"fte":{"type":"decimal","title":"The Fte Schema","example":1},"isEndDateConfirmed":{"type":"boolean","title":"The Is End Date Confirmed Schema","default":false,"example":false},"leave":{"type":"array","title":"Leave","description":"An array of Leave entries linked to this [Job](#tag/Jobs)","items":{"$ref":"#/definitions/leave"}},"locationId":{"description":"The UUIDv4 identifier for the location of this [Job](#tag/Jobs)","required":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"name":{"type":"string","title":"The Name Schema","example":"Chief Executive Officer","pattern":"^(.*)$"},"payGrade":{"type":"string","title":"The Paygrade Schema","example":"Founder","pattern":"^(.*)$"},"personId":{"description":"The identifier string for the person in this job","allOf":[{"$ref":"#/definitions/resourceId"}]},"recruitmentCost":{"type":"decimal","title":"The Recruitment Cost Schema","example":500},"source":{"type":"string","title":"The Source Schema","example":"Unknown","pattern":"^(.*)$"},"startDate":{"example":"2003-02-11T14:00:00+00:00","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"status":{"type":"string","title":"The Status Schema","example":"Current Job","pattern":"^(.*)$"},"supervisorId":{"description":"The identifier string for the supervisors job","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/resourceId"}]},"updatedAt":{"$ref":"#/definitions/updatedAt"},"workClassId":{"description":"The UUIDv4 identifier for the [Work Class](#tag/Work-Classes). Example [Work Classes](#tag/Work-Classes) might include Full-Time or Part-Time.","required":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"workTypeId":{"description":"The UUIDv4 identifier for the [Work Type](#tag/Work-Types). Example [Work Types](#tags/work-types) might include Permanent, Fixed Contract or Temporary/Casual","required":true,"allOf":[{"$ref":"#/definitions/resourceId"}]}},"required":["personId","startDate","name","businessUnitId","businessEntityId","workTypeId","workClassId"]},"jobs_list":{"type":"object","title":"List Jobs","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Job","properties":{"type":{"type":"string","enum":["jobs"],"readOnly":true},"id":{"description":"The identifier string for the job","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"The Job Data Model Schema","properties":{"startDate":{"example":"2003-02-11T14:00:00+00:00","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"endDate":{"example":"2017-02-11T14:00:00+00:00","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"isEndDateConfirmed":{"type":"boolean","title":"The Is End Date Confirmed Schema","default":false,"example":false},"name":{"type":"string","title":"The Name Schema","example":"Chief Executive Officer","pattern":"^(.*)$"},"businessUnit":{"type":"string","title":"The Business Unit Schema","example":"Executive","pattern":"^(.*)$"},"businessEntity":{"type":"string","title":"The Business Entity Schema","example":"intelliHR - AU","pattern":"^(.*)$"},"status":{"type":"string","title":"The Status Schema","example":"Current Job","pattern":"^(.*)$"},"workType":{"type":"string","title":"The Work Type Schema","example":"Permanent","pattern":"^(.*)$"},"workClass":{"type":"string","title":"The Work Class Schema","example":"Full-Time","pattern":"^(.*)$"},"payGrade":{"type":"string","title":"The Paygrade Schema","example":"Founder","pattern":"^(.*)$"},"fte":{"type":"decimal","title":"The Fte Schema","example":1},"supervisorId":{"description":"The identifier string for the supervisors job","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/resourceId"}]},"currency":{"$ref":"#/definitions/currency"},"recruitmentCost":{"type":"decimal","title":"The Recruitment Cost Schema","example":500},"source":{"type":"string","title":"The Source Schema","example":"Unknown","pattern":"^(.*)$"},"leave":{"type":"array","title":"Leave","description":"An array of Leave entries linked to this [Job](#tag/Jobs)","items":{"$ref":"#/definitions/leave"}},"location":{"type":"object","title":"The Location Schema","properties":{"name":{"type":"string","title":"The Name Schema","example":"Brisbane","pattern":"^(.*)$"},"address":{"type":"string","title":"The Address Schema","example":"Level 28, 345 Queen Street, Brisbane, 4000","pattern":"^(.*)$"}}},"personId":{"description":"The identifier string for the person in this job","allOf":[{"$ref":"#/definitions/resourceId"}]},"createdAt":{"$ref":"#/definitions/createdAt"},"updatedAt":{"$ref":"#/definitions/updatedAt"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/jobs?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/jobs?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/jobs?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/jobs?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/jobs?limit=1&page=5"}}}]}}},"locations_list":{"type":"object","title":"List locations","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"location","properties":{"type":{"type":"string","title":"The Type Schema","example":"locations","pattern":"^(.*)$"},"id":{"description":"The identifier string for the location","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"The Attributes Schema","properties":{"parentId":{"description":"The identifier string for the parent location","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/resourceId"}]},"name":{"type":"string","title":"The Name Schema","default":"","example":"Batcave","pattern":"^(.*)$"},"address":{"type":"string","title":"The Address Schema","default":"","example":"The Batcave","pattern":"^(.*)$"},"isEnabled":{"type":"boolean","default":true,"title":"The isEnabled Schema","example":true},"createdAt":{"$ref":"#/definitions/createdAt"},"updatedAt":{"$ref":"#/definitions/updatedAt"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/locations?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/locations?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/locations?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/locations?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/locations?limit=1&page=5"}}}]}}},"pay-grades_list":{"type":"object","title":"List Pay Grades","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"payGrade","properties":{"type":{"type":"string","example":"payGrades"},"id":{"allOf":[{"description":"The identifier string for the pay grade","readOnly":true},{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"The Attributes Schema","properties":{"name":{"type":"string","description":"User friendly name given to the Pay Grade","example":"Level 1 - Executive"},"code":{"type":"string","description":"Administrative, short code associated to the Pay Grade","example":"L1"},"sortOrder":{"$ref":"#/definitions/sortOrder"},"isEnabled":{"type":"boolean","description":"Specifies if this resource is still available for user selection","example":true},"createdAt":{"$ref":"#/definitions/createdAt"},"updatedAt":{"$ref":"#/definitions/updatedAt"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/pay-grades?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/pay-grades?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/pay-grades?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/pay-grades?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/pay-grades?limit=1&page=5"}}}]}}},"people":{"type":"object","title":"Single Person","properties":{"data":{"type":"object","title":"Person","properties":{"type":{"type":"string","title":"Data Model type","description":"The name of the data model that is being returned","example":"people"},"id":{"description":"The identifier string for the person","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Person attributes","properties":{"preferredName":{"type":"string","title":"Preferred Name","description":"Every employee has an option to set a preferred name.","example":"Batman"},"preferredOrFirstName":{"type":"string","title":"First of Last Name","description":"Will return preferredName, or, if preferredName is not set, will return fistName","example":"Batman"},"firstName":{"type":"string","title":"First Name","example":"Bruce"},"middleNames":{"type":"string","title":"Middle Names","example":"Thomas"},"lastName":{"type":"string","title":"Last Name","example":"Wayne"},"displayName":{"type":"string","title":"Display Name","description":"Will follow the following pattern: `preferredName (firstName) lastName`","example":"Batman (Bruce) Wayne"},"legalName":{"type":"string","title":"Legal Name","description":"Has the following pattern: `firstName middleNames lastName`","example":"Bruce Thomas Wayne"},"dateOfBirth":{"type":"string","title":"dateOfBirth","description":"Date of Birth (Y-m-d)","example":"1939-07-23","pattern":"^((((19|[2-9]\\d)\\d{2})-(0[13578]|1[02])-(0[1-9]|[12]\\d|3[01]))|(((19|[2-9]\\d)\\d{2})-(0[13456789]|1[012])-(0[1-9]|[12]\\d|30))|(((19|[2-9]\\d)\\d{2})-02-(0[1-9]|1\\d|2[0-8]))|(((1[6-9]|[2-9]\\d)(0[48]|[2468][048]|[13579][26])|((16|[2468][048]|[3579][26])00))-02-29))$"},"gender":{"type":"string","description":"Human readable string for the persons gender","example":"Male"},"genderId":{"title":"Gender ID","allOf":[{"$ref":"#/definitions/resourceId"}]},"employeeNumber":{"type":"string","description":"A manually entered employee number that identifies a [Person](#tags/people) in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.","example":"00001"},"intellihrId":{"description":"An auto generated number that uniquely identifies a [Person](#tags/people) in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.","type":"number","minimum":995,"example":1000},"titleId":{"title":"Title ID","allOf":[{"$ref":"#/definitions/resourceId"}]},"emergencyContact":{"type":"object","title":"Emergency Contact","properties":{"name":{"type":"string","title":"Full Name","description":"First and last names of the emergency contact","example":"Selina Kyle"},"relationship":{"type":"string","example":"Colleague"},"phone":{"type":"string","example":"00 0000 0000"},"email":{"type":"string","example":"selena.kyle@batman.org","pattern":"^([a-zA-Z0-9_\\-.]+)@([a-zA-Z0-9_\\-.]+)\\.([a-zA-Z]{2,5})$"}}},"profilePictureId":{"description":"The identifier string for the profile picture","allOf":[{"$ref":"#/definitions/resourceId"}]},"profileCoverPictureId":{"description":"The identifier string for the profile cover picture","allOf":[{"$ref":"#/definitions/resourceId"}]},"workRightExpiryDate":{"description":"","example":"2029-10-27T22:30:00+00:00","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"employmentStatus":{"enum":["Current Staff","Exiting Staff","No Job Records","Past Staff","Returning Staff","Upcoming Staff"],"example":"Current Staff","type":"string"},"jobs":{"type":"array","title":"Jobs","description":"An array of Job entries associated with this Person","items":{"properties":{"id":{"description":"The identifier string for the job","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"name":{"type":"string","title":"Job Name","example":"Software Engineer"},"startDate":{"example":"2003-02-11T14:00:00+00:00","description":"Job's effective start date.","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"endDate":{"example":"2017-02-11T14:00:00+00:00","description":"Job's effective end date.","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"createdAt":{"description":"The timestamp the Job entry was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"description":"The timestamp the Job entry was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]}}}},"emailAddresses":{"type":"array","title":"Email Addresses","description":"An array of Email Addresses associated with this [Person](#tags/people)","items":{"properties":{"id":{"description":"The identifier string for the email address","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"email":{"type":"string","description":"The email address","example":"bruce.wayne@batman.org"},"isPrimary":{"description":"Specifies if this email address is their primary address used for sending emails","example":true,"type":"boolean"},"isPersonal":{"description":"Specifies if this email address is owned personally (i.e. not handed out by the company)","example":false,"type":"boolean"}}}},"createdAt":{"description":"The timestamp the Person entry was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"description":"The timestamp the Person entry was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]}}}}}}},"people_create":{"type":"object","required":["lastName"],"properties":{"dateOfBirth":{"type":"string","title":"dateOfBirth","description":"Date of Birth (Y-m-d)","nullable":true,"default":null,"pattern":"^((((19|[2-9]\\d)\\d{2})-(0[13578]|1[02])-(0[1-9]|[12]\\d|3[01]))|(((19|[2-9]\\d)\\d{2})-(0[13456789]|1[012])-(0[1-9]|[12]\\d|30))|(((19|[2-9]\\d)\\d{2})-02-(0[1-9]|1\\d|2[0-8]))|(((1[6-9]|[2-9]\\d)(0[48]|[2468][048]|[13579][26])|((16|[2468][048]|[3579][26])00))-02-29))$"},"emergencyContactEmail":{"type":"string","description":"Emergency Contact Email","default":""},"emergencyContactName":{"type":"string","description":"Emergency Contact Name","default":""},"emergencyContactPhone":{"type":"string","description":"Emergency Contact Phone","default":""},"emergencyContactPhoneCountryId":{"description":"Emergency Contact Phone Number CountryId, if not provided, will default to `Australia`","default":"039f60d5-1b38-451a-b191-5e4b86273324","allOf":[{"$ref":"#/definitions/resourceId"}]},"emergencyContactRelationship":{"description":"Emergency Contact Relationship","type":"string","default":""},"employeeNumber":{"description":"Employee Number","type":"string","nullable":true,"default":null},"firstName":{"description":"First Name","type":"string","default":""},"gender":{"description":"Human readable gender name. If `genderId` is also provided, this parameter will be ignored. Searching is done case-insensitively and 'starts-with' e.g. passing `male` will match with a [Gender](#tags/genders) called `Male` as will `m` or `M`. If multiple [Genders](#tags/genders) match the first will be chosen.","type":"string","default":"","example":"Other"},"genderId":{"description":"GenderId will default to `Other`","default":"f8e59a09-06be-4852-8f07-8d1040b8ea0c","allOf":[{"$ref":"#/definitions/resourceId"}]},"lastName":{"description":"Last Name","type":"string"},"middleName":{"description":"Middle Name(s)","type":"string","default":""},"preferredName":{"description":"Preferred Name","type":"string","default":""},"titleId":{"nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/resourceId"}]},"emailAddresses":{"type":"array","description":"Array of Email Addresses.","default":null,"nullable":true,"items":{"required":["email"],"properties":{"isPersonal":{"type":"boolean","title":"Is Personal","description":"Denotes if this Email Address is Personal","default":false},"isPrimary":{"type":"boolean","title":"Is Primary","description":"This flag is used for notifications. Only one `Primary` Email Address is allowed per person. If you add a new `Primary` Email Address, any existing `Primary` Email Address marks will be cleared.","default":false},"email":{"type":"string","pattern":"^([a-zA-Z0-9_\\-.]+)@([a-zA-Z0-9_\\-.]+)\\.([a-zA-Z]{2,5})$"},"name":{"type":"string","title":"Entry Name","description":"A logical identifier for this Email Address entry."}}}},"phoneNumbers":{"type":"array","description":"Array of Phone Numbers","default":null,"nullable":true,"items":{"required":["phone"],"properties":{"isPersonal":{"type":"boolean","title":"Is Personal","description":"Denotes if this Phone Number is Personal","default":false},"isPrimary":{"type":"boolean","title":"Is Primary","description":"This flag is used for notifications. Only one `Primary` Phone Number is allowed per person. If you add a new `Primary` Phone Number, any existing `Primary` Phone Number marks will be cleared.","default":false},"phone":{"type":"string","title":"Phone Number"},"countryId":{"description":"Please note that if you provide a valid country code with the phone number, a matching [Country](#tag/Countries) will be automatically associated with this Phone Number record.","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/resourceId"}]}}}}}},"people_list":{"type":"object","title":"List People","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Person","properties":{"type":{"type":"string","title":"Data Model type","description":"The name of the data model that is being returned","example":"people"},"id":{"description":"The identifier string for the person","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Person attributes","properties":{"preferredName":{"type":"string","title":"Preferred Name","description":"Every employee has an option to set a preferred name.","example":"Batman"},"preferredOrFirstName":{"type":"string","title":"First of Last Name","description":"Will return preferredName, or, if preferredName is not set, will return fistName","example":"Batman"},"firstName":{"type":"string","title":"First Name","example":"Bruce"},"middleNames":{"type":"string","title":"Middle Names","example":"Thomas"},"lastName":{"type":"string","title":"Last Name","example":"Wayne"},"displayName":{"type":"string","title":"Display Name","description":"Will follow the following pattern: `preferredName (firstName) lastName`","example":"Batman (Bruce) Wayne"},"legalName":{"type":"string","title":"Legal Name","description":"Has the following pattern: `firstName middleNames lastName`","example":"Bruce Thomas Wayne"},"dateOfBirth":{"type":"string","title":"dateOfBirth","description":"Date of Birth (Y-m-d)","example":"1939-07-23","pattern":"^((((19|[2-9]\\d)\\d{2})-(0[13578]|1[02])-(0[1-9]|[12]\\d|3[01]))|(((19|[2-9]\\d)\\d{2})-(0[13456789]|1[012])-(0[1-9]|[12]\\d|30))|(((19|[2-9]\\d)\\d{2})-02-(0[1-9]|1\\d|2[0-8]))|(((1[6-9]|[2-9]\\d)(0[48]|[2468][048]|[13579][26])|((16|[2468][048]|[3579][26])00))-02-29))$"},"gender":{"type":"string","description":"Human readable string for the persons gender","example":"Male"},"genderId":{"title":"Gender ID","allOf":[{"$ref":"#/definitions/resourceId"}]},"employeeNumber":{"type":"string","description":"A manually entered employee number that identifies a [Person](#tags/people) in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.","example":"00001"},"intellihrId":{"description":"An auto generated number that uniquely identifies a [Person](#tags/people) in intelliHR. It may be hidden in the system's UI depending upon your tenant's configuration.","type":"number","minimum":995,"example":1000},"titleId":{"title":"Title ID","allOf":[{"$ref":"#/definitions/resourceId"}]},"emergencyContact":{"type":"object","title":"Emergency Contact","properties":{"name":{"type":"string","title":"Full Name","description":"First and last names of the emergency contact","example":"Selina Kyle"},"relationship":{"type":"string","example":"Colleague"},"phone":{"type":"string","example":"00 0000 0000"},"email":{"type":"string","example":"selena.kyle@batman.org","pattern":"^([a-zA-Z0-9_\\-.]+)@([a-zA-Z0-9_\\-.]+)\\.([a-zA-Z]{2,5})$"}}},"profilePictureId":{"description":"The identifier string for the profile picture","allOf":[{"$ref":"#/definitions/resourceId"}]},"profileCoverPictureId":{"description":"The identifier string for the profile cover picture","allOf":[{"$ref":"#/definitions/resourceId"}]},"workRightExpiryDate":{"description":"","example":"2029-10-27T22:30:00+00:00","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"employmentStatus":{"enum":["Current Staff","Exiting Staff","No Job Records","Past Staff","Returning Staff","Upcoming Staff"],"example":"Current Staff","type":"string"},"jobs":{"type":"array","title":"Jobs","description":"An array of Job entries associated with this Person","items":{"properties":{"id":{"description":"The identifier string for the job","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"name":{"type":"string","title":"Job Name","example":"Software Engineer"},"startDate":{"example":"2003-02-11T14:00:00+00:00","description":"Job's effective start date.","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"endDate":{"example":"2017-02-11T14:00:00+00:00","description":"Job's effective end date.","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"createdAt":{"description":"The timestamp the Job entry was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"description":"The timestamp the Job entry was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]}}}},"emailAddresses":{"type":"array","title":"Email Addresses","description":"An array of Email Addresses associated with this [Person](#tags/people)","items":{"properties":{"id":{"description":"The identifier string for the email address","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"email":{"type":"string","description":"The email address","example":"bruce.wayne@batman.org"},"isPrimary":{"description":"Specifies if this email address is their primary address used for sending emails","example":true,"type":"boolean"},"isPersonal":{"description":"Specifies if this email address is owned personally (i.e. not handed out by the company)","example":false,"type":"boolean"}}}},"createdAt":{"description":"The timestamp the Person entry was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"description":"The timestamp the Person entry was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/people?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/people?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/people?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/people?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/people?limit=1&page=5"}}}]}}},"recruitment-sources_list":{"type":"object","title":"List Recruitment Sources","properties":{"data":{"type":"array","title":"recruitmentSource","description":"Recruitment source details","items":{"type":"object","title":"recruitmentSource","properties":{"type":{"type":"string","example":"recruitmentSources"},"id":{"allOf":[{"description":"The identifier string for the recruitment source","readOnly":true},{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","properties":{"name":{"type":"string","description":"The name given to this recruitment source","example":"Direct"},"parentId":{"allOf":[{"description":"The identifier string for the parent recruitment source","nullable":true},{"$ref":"#/definitions/resourceId"}]},"sortOrder":{"allOf":[{"$ref":"#/definitions/sortOrder"}]},"isEnabled":{"type":"boolean","example":true,"description":"Specifies if this recruitment source is still available for user selection"},"createdAt":{"$ref":"#/definitions/createdAt"},"updatedAt":{"$ref":"#/definitions/updatedAt"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/recruitment-sources?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/recruitment-sources?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/recruitment-sources?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/recruitment-sources?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/recruitment-sources?limit=1&page=5"}}}]}}},"titles_list":{"type":"object","title":"List Titles","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Title","properties":{"type":{"type":"string","title":"type","example":"titles","pattern":"^(.*)$"},"id":{"description":"The identifier string for the title","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"attributes","properties":{"isEnabled":{"allOf":[{"$ref":"#/definitions/isEnabled"}]},"isSystem":{"example":true,"title":"isSystem","type":"boolean"},"name":{"example":"Mx","title":"name","type":"string"},"sortOrder":{"allOf":[{"$ref":"#/definitions/sortOrder"}]}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/titles?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/titles?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/titles?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/titles?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/titles?limit=1&page=5"}}}]}}},"trainings":{"type":"object","title":"Single Training","properties":{"data":{"type":"object","title":"Training","properties":{"type":{"type":"string","title":"Data Model type","description":"The name of the data model that is being returned","example":"trainings"},"id":{"description":"The identifier string for the training","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Training attributes","properties":{"name":{"type":"string","description":"Name given to this [Training](#tag/Trainings)","example":"Accounting Compliance 101"},"personId":{"description":"The ID of the [Person](#tag/People) who did the [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"personName":{"type":"string","description":"The name of the [Person](#tag/People) who did the [Training](#tag/Trainings)","example":"Batman (Bruce) Wayne"},"jobId":{"description":"The ID of the [Job](#tag/Jobs) that this [Training](#tag/Trainings) was completed for","allOf":[{"$ref":"#/definitions/resourceId"}]},"jobName":{"type":"string","description":"The name of the [Job](#tag/Jobs) that this [Training](#tag/Trainings) was completed for","example":"Chief Executive Officer"},"coordinatorPersonId":{"description":"The ID of the [Person](#tag/People) who coordinated the [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"coordinatorPersonName":{"type":"string","description":"The name of the [Person](#tag/People) who coordinated the [Training](#tag/Trainings)","example":"Batman (Bruce) Wayne"},"hours":{"description":"How many hours were spent on this [Training](#tag/Trainings)","anyOf":[{"type":"null"},{"type":"string"}],"pattern":"^[0-9]+.?[0-9]*$"},"cost":{"description":"The cost of this [Training](#tag/Trainings)","anyOf":[{"type":"null"},{"type":"string"}],"pattern":"^[0-9]+.?[0-9]*$"},"currency":{"$ref":"#/definitions/currency"},"providerId":{"description":"The ID of the [Training Provider](#tag/Training-Providers) for this [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"providerName":{"type":"string","description":"The name of the [Training Provider](#tag/Training-Types) for this [Training](#tag/Trainings)","example":"External"},"typeId":{"description":"The ID of the [Training Type](#tag/Training-Types) for this [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"typeName":{"type":"string","description":"The name of the [Training Type](#tag/Training-Types) for this [Training](#tag/Trainings)","example":"Core Skills"},"completionDate":{"description":"The timestamp the [Training](#tag/Trainings) was completed","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"createdAt":{"description":"The timestamp the [Training](#tag/Trainings) was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"description":"The timestamp the [Training](#tag/Trainings) was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"customFields":{"description":"Custom Fields defined on this training with their values","allOf":[{"$ref":"#/definitions/customFieldsResponse"}]}}}}}}},"trainings_create_request":{"type":"object","title":"Training","required":["completionDate","currency","coordinatorPersonId","jobId","name","personId","providerId","typeId"],"properties":{"id":{"description":"The identifier string for the training","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"typeId":{"description":"The ID of the [Training Type](#tag/Training-Types) for this [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"personId":{"description":"The ID of the [Person](#tag/People) who did the [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"jobId":{"description":"The ID of the [Job](#tag/Jobs) that this [Training](#tag/Trainings) was completed for","allOf":[{"$ref":"#/definitions/resourceId"}]},"providerId":{"description":"The ID of the [Training Provider](#tag/Training-Providers) for this [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"name":{"type":"string","description":"Name given to this [Training](#tag/Trainings)","example":"Accounting Compliance 101"},"hours":{"description":"How many hours were spent on this [Training](#tag/Trainings)","type":"string","pattern":"^[0-9]+.?[0-9]*$"},"currency":{"$ref":"#/definitions/currency"},"cost":{"description":"The cost of this [Training](#tag/Trainings)","type":"string","pattern":"^[0-9]+.?[0-9]*$"},"coordinatorPersonId":{"description":"The ID of the [Person](#tag/People) who coordinated the [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"completionDate":{"description":"The timestamp the [Training](#tag/Trainings) was completed","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"customFields":{"description":"The custom field values for this [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/customFieldsRequest"}]}}},"trainings_patch_request":{"type":"object","title":"Training","properties":{"id":{"description":"The identifier string for the training","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"typeId":{"description":"The ID of the [Training Type](#tag/Training-Types) for this [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"personId":{"description":"The ID of the [Person](#tag/People) who did the [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"jobId":{"description":"The ID of the [Job](#tag/Jobs) that this [Training](#tag/Trainings) was completed for","allOf":[{"$ref":"#/definitions/resourceId"}]},"providerId":{"description":"The ID of the [Training Provider](#tag/Training-Providers) for this [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"name":{"type":"string","description":"Name given to this [Training](#tag/Trainings)","example":"Accounting Compliance 101"},"hours":{"description":"How many hours were spent on this [Training](#tag/Trainings)","type":"string","pattern":"^[0-9]+.?[0-9]*$"},"currency":{"$ref":"#/definitions/currency"},"cost":{"description":"The cost of this [Training](#tag/Trainings)","type":"string","pattern":"^[0-9]+.?[0-9]*$"},"coordinatorPersonId":{"description":"The ID of the [Person](#tag/People) who coordinated the [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"completionDate":{"description":"The timestamp the [Training](#tag/Trainings) was completed","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"customFields":{"description":"The custom field values for this [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/customFieldsRequest"}]}}},"trainings_list":{"type":"object","title":"List of Trainings","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Training","properties":{"type":{"type":"string","title":"Data Model type","description":"The name of the data model that is being returned","example":"trainings"},"id":{"description":"The identifier string for the training","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Training attributes","properties":{"name":{"type":"string","description":"Name given to this [Training](#tag/Trainings)","example":"Accounting Compliance 101"},"personId":{"description":"The ID of the [Person](#tag/People) who did the [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"personName":{"type":"string","description":"The name of the [Person](#tag/People) who did the [Training](#tag/Trainings)","example":"Batman (Bruce) Wayne"},"jobId":{"description":"The ID of the [Job](#tag/Jobs) that this [Training](#tag/Trainings) was completed for","allOf":[{"$ref":"#/definitions/resourceId"}]},"jobName":{"type":"string","description":"The name of the [Job](#tag/Jobs) that this [Training](#tag/Trainings) was completed for","example":"Chief Executive Officer"},"coordinatorPersonId":{"description":"The ID of the [Person](#tag/People) who coordinated the [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"coordinatorPersonName":{"type":"string","description":"The name of the [Person](#tag/People) who coordinated the [Training](#tag/Trainings)","example":"Batman (Bruce) Wayne"},"hours":{"description":"How many hours were spent on this [Training](#tag/Trainings)","anyOf":[{"type":"null"},{"type":"string"}],"pattern":"^[0-9]+.?[0-9]*$"},"cost":{"description":"The cost of this [Training](#tag/Trainings)","anyOf":[{"type":"null"},{"type":"string"}],"pattern":"^[0-9]+.?[0-9]*$"},"currency":{"$ref":"#/definitions/currency"},"providerId":{"description":"The ID of the [Training Provider](#tag/Training-Providers) for this [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"providerName":{"type":"string","description":"The name of the [Training Provider](#tag/Training-Types) for this [Training](#tag/Trainings)","example":"External"},"typeId":{"description":"The ID of the [Training Type](#tag/Training-Types) for this [Training](#tag/Trainings)","allOf":[{"$ref":"#/definitions/resourceId"}]},"typeName":{"type":"string","description":"The name of the [Training Type](#tag/Training-Types) for this [Training](#tag/Trainings)","example":"Core Skills"},"completionDate":{"description":"The timestamp the [Training](#tag/Trainings) was completed","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"createdAt":{"description":"The timestamp the [Training](#tag/Trainings) was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"description":"The timestamp the [Training](#tag/Trainings) was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"customFields":{"description":"Custom Fields defined on this training with their values","allOf":[{"$ref":"#/definitions/customFieldsResponse"}]}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/trainings?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/trainings?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/trainings?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/trainings?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/trainings?limit=1&page=5"}}}]}}},"training-types_list":{"type":"object","title":"List Training Types","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Training Types","properties":{"type":{"type":"string","title":"Data Model type","description":"The name of the data model that is being returned","example":"training-providers"},"id":{"description":"The identifier string for the training type","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Training Type attributes","properties":{"name":{"type":"string","description":"Name given to this [Training Type](#tag/Training-Types)","example":"Soft Skills"},"sortOrder":{"description":"what order to display this [Training Type](#tag/Training-Types) in reference to the others","minimum":0,"type":"integer"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/training-types?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/training-types?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/training-types?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/training-types?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/training-types?limit=1&page=5"}}}]}}},"training-providers_list":{"type":"object","title":"List Training Providers","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Training Providers","properties":{"type":{"type":"string","title":"Data Model type","description":"The name of the data model that is being returned","example":"training-providers"},"id":{"description":"The identifier string for the training provider","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Training Provider attributes","properties":{"name":{"type":"string","description":"Name given to this [Training Provider](#tag/Training-Providers)","example":"HR Training Team"},"sortOrder":{"description":"what order to display this [Training Provider](#tag/Training-Providers) in reference to the others","minimum":0,"type":"integer"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/training-providers?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/training-providers?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/training-providers?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/training-providers?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/training-providers?limit=1&page=5"}}}]}}},"webhook-events_list":{"type":"object","title":"List Webhook Events","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Webhook Event","properties":{"id":{"description":"The identifier string for the webhook event","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Webhook Event attributes","properties":{"name":{"type":"string","title":"Name","description":"The descriptive name of the webhook event","example":"Person Created Event"},"event":{"type":"string","title":"Event Slug","description":"The slug of the webhook event","example":"person.created"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/webhook-events?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/webhook-events?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/webhook-events?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/webhook-events?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/webhook-events?limit=1&page=5"}}}]}}},"webhooks":{"type":"object","title":"Single Webhook","properties":{"data":{"type":"object","title":"Webhook","properties":{"id":{"description":"The identifier string for the webhook","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Webhook attributes","properties":{"url":{"type":"string","title":"URL","description":"The webhook endpoint which the request will be sent to when the subscribed event is triggered.","example":"http://example.com"},"webhookEventId":{"title":"Webhook Event ID","allOf":[{"$ref":"#/definitions/resourceId"}]},"isEnabled":{"title":"Is Enabled","description":"Specifies if this webhook is enabled","example":true,"type":"boolean"},"source":{"title":"Source","description":"A string specifying the source of creation for this webhook","example":"zapier","type":"string"},"createdAt":{"title":"Created At","description":"The timestamp the webhook entry was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"title":"Updated At","description":"The timestamp the webhook entry was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]}}}}}}},"webhooks_create":{"type":"object","required":["url","webhookEvent"],"properties":{"url":{"type":"string","title":"URL","description":"The webhook endpoint which the request will be sent to when the subscribed event is triggered"},"webhookEvent":{"description":"The name of the [Webhook Event](#tag/Webhook-Events) e.g. `person.created`, `training.deleted`","title":"Webhook Event","type":"string"},"isEnabled":{"type":"boolean","title":"Is Enabled","description":"Denotes if this webhook is enabled","default":true},"source":{"type":"string","title":"The source of the webhook","description":"A string specifying the source of creation for this webhook","default":"custom"}}},"webhooks_patch":{"type":"object","properties":{"url":{"type":"string","title":"URL","description":"The webhook endpoint which the request will be sent to when the subscribed event is triggered. If it is not provided, it will be default to the one specified in creation"},"webhookEventId":{"description":"The ID of the webhook event. If it is not provided, it will be default to the one specified in creation","allOf":[{"$ref":"#/definitions/resourceId"}]},"isEnabled":{"type":"boolean","title":"Is Enabled","description":"Denotes if this webhook is enabled. If it is not provided, it will be default to the one specified in creation"},"source":{"type":"string","title":"The source of the webhook","description":"A string specifying the source of creation for this webhook. If it is not provided, it will be default to the one specified in creation"}}},"webhooks_list":{"type":"object","title":"List Webhooks","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Webhook","properties":{"id":{"description":"The identifier string for the webhook","readOnly":true,"allOf":[{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"Webhook attributes","properties":{"url":{"type":"string","title":"URL","description":"The webhook endpoint which the request will be sent to when the subscribed event is triggered.","example":"http://example.com"},"webhookEventId":{"title":"Webhook Event ID","allOf":[{"$ref":"#/definitions/resourceId"}]},"isEnabled":{"title":"Is Enabled","description":"Specifies if this webhook is enabled","example":true,"type":"boolean"},"source":{"title":"Source","description":"A string specifying the source of creation for this webhook","example":"zapier","type":"string"},"createdAt":{"title":"Created At","description":"The timestamp the webhook entry was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"title":"Updated At","description":"The timestamp the webhook entry was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/webhooks?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/webhooks?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/webhooks?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/webhooks?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/webhooks?limit=1&page=5"}}}]}}},"work-classes_list":{"type":"object","title":"List Work Classes","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"Work Classes Schema","properties":{"type":{"type":"string","title":"Data Model Type","description":"The name of the data model that is being returned.","example":"workClasses","pattern":"^(.*)$"},"id":{"allOf":[{"description":"The identifier string for the work class","readOnly":true},{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"The Attributes Schema","description":"Work Class attributes","properties":{"name":{"type":"string","title":"","description":"","example":"Casual","pattern":"^(.*)$"},"workTypeId":{"allOf":[{"description":"The identifier string for the work type"},{"$ref":"#/definitions/resourceId"}]},"sortOrder":{"allOf":[{"$ref":"#/definitions/sortOrder"}]},"isEnabled":{"type":"boolean","description":"This flag will indicate if a Work Class can or cannot be used for a Job configuration.","example":true},"createdAt":{"$ref":"#/definitions/createdAt"},"updatedAt":{"$ref":"#/definitions/updatedAt"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/work-classes?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/work-classes?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/work-classes?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/work-classes?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/work-classes?limit=1&page=5"}}}]}}},"work-types_list":{"type":"object","title":"List Work Types","properties":{"data":{"type":"array","title":"data","items":{"type":"object","title":"workType","properties":{"type":{"type":"string","title":"The Type Schema","description":"The name of the data model that is being returned.","example":"workTypes","pattern":"^(.*)$"},"id":{"allOf":[{"description":"The identifier string for the work type","readOnly":true},{"$ref":"#/definitions/resourceId"}]},"attributes":{"type":"object","title":"The Attributes Schema","description":"Work Type attributes","properties":{"name":{"type":"string","title":"Work Type Name","description":"'Part Time' could be an example of a Work Type name.","example":"Permanent"},"sortOrder":{"allOf":[{"$ref":"#/definitions/sortOrder"}]},"isEnabled":{"type":"boolean","description":"This flag will indicate if a Work Type can or cannot be used for a Job configuration.","example":true},"createdAt":{"$ref":"#/definitions/createdAt"},"updatedAt":{"$ref":"#/definitions/updatedAt"}}}}}},"meta":{"$ref":"#/definitions/meta/pagination"},"links":{"allOf":[{"$ref":"#/definitions/links"},{"properties":{"self":{"example":"https://api.intellihr.io/work-types?limit=1&page=3"},"first":{"example":"https://api.intellihr.io/work-types?limit=1&page=1"},"prev":{"example":"https://api.intellihr.io/work-types?limit=1&page=2"},"next":{"example":"https://api.intellihr.io/work-types?limit=1&page=4"},"last":{"example":"https://api.intellihr.io/work-types?limit=1&page=5"}}}]}}}}},"servers":[{"url":"https://api.intellihr.io","description":"Live Server"}],"security":[{"ApiKey":[]}],"responses":{"errors":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","title":"Bad Request","properties":{"errors":{"type":"array","title":"Errors","description":"List of errors identified by the server.","items":{"properties":{"code":{"type":"integer","title":"Code","description":"HTTP Status Code for the error."},"detail":{"type":"string","title":"Details","description":"A description of the propblem encountered by the server."}}}}}},"example":{"value":{"errors":[{"code":400,"detail":"An invalid UUID was provided"},{"code":400,"detail":"An invalid email address was provided"}]}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","title":"Forbidden","properties":{"name":{"type":"string","title":"Name"},"message":{"type":"string","title":"Message"},"code":{"type":"integer","title":"Code","description":"HTTP Status Code for the error."},"className":{"type":"string","title":"Error Class"},"errors":{"type":"object","title":"Errors"}}},"example":{"value":{"name":"Forbidden","message":"Error","code":403,"className":"forbidden","errors":{}}}}}},"500":{"description":"General Error","content":{"application/json":{"schema":{"type":"object","title":"General Error","description":"Unknows server error","properties":{"name":{"type":"string","title":"Error Name"},"message":{"type":"string","title":"Message","description":"A brief information about what might have happened."},"code":{"type":"integer","title":"Error Code","description":"HTTP Status Code for the error"},"className":{"type":"string","title":"Error Class"},"errors":{"type":"object","title":"Errors"}}},"example":{"value":{"name":"GeneralError","message":"Error","code":500,"className":"general-error","errors":{}}}}}}}},"definitions":{"meta":{"pagination":{"type":"object","description":"Contains miscellaneous meta pagination details","properties":{"pagination":{"type":"object","description":"Contains information related to the pagiation of the response","properties":{"total":{"type":"integer","description":"Total items count","minimum":0,"example":50},"count":{"type":"integer","description":"Number of items for current page","minimum":0,"example":10},"per_page":{"type":"integer","description":"Items per page limit","minimum":0,"example":10},"current_page":{"type":"integer","description":"Current page","minimum":1,"example":3},"total_pages":{"type":"integer","description":"Total number of pages","minimum":1,"example":5}}}}}},"links":{"type":"object","description":"The links related to resource","properties":{"self":{"type":"string","description":"The current page URL","example":"https://api.intellihr.io/foo?limit=1&page=3"},"first":{"type":"string","description":"The first page URL","example":"https://api.intellihr.io/foo?limit=1&page=1"},"prev":{"type":"string","description":"The previous page URL","example":"https://api.intellihr.io/foo?limit=1&page=2"},"next":{"type":"string","description":"The next page URL","example":"https://api.intellihr.io/foo?limit=1&page=4"},"last":{"type":"string","description":"The last page URL","example":"https://api.intellihr.io/foo?limit=1&page=5"}}},"resourceId":{"type":"string","title":"UUIDv4","description":"The resources v4 UUID.","maxLength":36,"minLength":36,"example":"8a5f3ea6-ea6b-4425-8a87-3c256bb7b6f9"},"isEnabled":{"description":"Specifies if this resource should still be available for user selection","example":true,"type":"boolean"},"sortOrder":{"type":"integer","description":"Order configured by the users to use when displaying as e.g. a list","default":0,"example":1},"createdAt":{"title":"The timestamp the record was created","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"updatedAt":{"title":"The timestamp the record was last updated","allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"rfcDateTime":{"type":"string","title":"RFC3339 datetime","example":"2015-03-01T22:30:00+00:00","description":"The date-time format defined by [RFC3339](https://tools.ietf.org/html/rfc3339#section-5.6)"},"customFieldsRequest":{"type":"object","additionalProperties":{"type":"object","description":"Custom fields will be keyed by their api_name. Custom fields are not required, and will default to having null values.","properties":{"value":{"description":"The value for this custom field. This value structure will depend upon the type of the custom field.","anyOf":[{"type":"null","description":"The value will be null when a custom field is not provided or is empty for a record. Null can be provided to delete a custom field value."},{"type":"string","description":"For TEXT and NUMBER records, the value is stored as a string with the value of the record."},{"type":"object","properties":{"label":{"type":"string","description":"For SINGLE_SELECT records, the value is stored as an object with the label of the dropdown option. NOTE: Only the label needs to be provided. `id` is not required."}}},{"type":"object","properties":{"labels":{"type":"array","minItems":1,"description":"For MULTI_SELECT records, the value is stored an object with array of labels for all selected options. NOTE: Only the labels need to be provided. `ids` is not required.","items":{"type":"string"}}}}]}}},"example":{"text_field_api_name":{"value":"Some text value"},"numeric_field_api_name":{"value":"50"},"single_select_api_name":{"value":{"label":"Drama"}},"multi_select_api_name":{"value":{"labels":["Bananas","Apples"]}},"field_not_provided_api_name":{"value":null}}},"customFieldsResponse":{"type":"object","additionalProperties":{"type":"object","description":"Custom fields will be keyed by their api_name. Custom fields will always appear on an object if defined, and will default to having null values.","properties":{"definitionId":{"description":"The ID of the Custom Field Definition for this custom field","allOf":[{"$ref":"#/definitions/resourceId"}]},"name":{"description":"The human readable name of the Custom Field Definition for this custom field","type":"string"},"type":{"description":"The type of the Custom Field Definition for this custom field","type":"string","enum":["TEXT","NUMBER","SINGLE_SELECT","MULTI_SELECT"]},"value":{"description":"The value for this custom field. This value structure will depend upon the type of the custom field.","anyOf":[{"type":"null","description":"The value will be null when a custom field is not provided or is empty for a record."},{"type":"string","description":"For TEXT and NUMBER records, the value is a string with the value of the record."},{"type":"object","properties":{"id":{"description":"For SINGLE_SELECT records, the value is an object with the id and label of the dropdown option","allOf":[{"$ref":"#/definitions/resourceId"}]},"label":{"type":"string"}}},{"type":"object","properties":{"ids":{"type":"array","description":"For MULTI_SELECT records, the value is an object with an array of ids and array of labels for all selected options","minItems":1,"items":{"$ref":"#/definitions/resourceId"}},"labels":{"type":"array","minItems":1,"items":{"type":"string"}}}}]}}},"example":{"text_field_api_name":{"definitionId":"e82690b4-caac-471e-94f9-9b76fa9df131","name":"Description","type":"TEXT","value":"Some text value"},"numeric_field_api_name":{"definitionId":"e82690b4-caac-471e-94f9-9b76fa9df131","name":"CPD Points","type":"NUMBER","value":"50"},"single_select_api_name":{"definitionId":"e82690b4-caac-471e-94f9-9b76fa9df131","name":"Category","type":"SINGLE_SELECT","value":{"id":"df81d8bb-59d3-45be-a3e3-c1f8d1c0de36","label":"Drama"}},"multi_select_api_name":{"definitionId":"e82690b4-caac-471e-94f9-9b76fa9df131","name":"Favorite Foods","type":"MULTI_SELECT","value":{"ids":["df81d8bb-59d3-45be-a3e3-c1f8d1c0de36","6fda08b8-f5ca-4be5-8809-71e63bcf47dc"],"labels":["Bananas","Apples"]}},"field_not_provided_api_name":{"definitionId":"e82690b4-caac-471e-94f9-9b76fa9df131","name":"Optional other text field","type":"TEXT","value":null}}},"currency":{"type":"string","title":"Currency code","description":"An international currency code. Typically AUD for Australian dollar, USD for American dollar etc. See [Official list of codes](https://www.iban.com/currency-codes).","example":"AUD","pattern":"^[A-Z]{3}$"},"leave":{"type":"object","title":"Person's leave","properties":{"id":{"description":"Unique identifier for this Leave entry","allOf":[{"$ref":"#/definitions/resourceId"}]},"jobId":{"description":"[Job](#tag/Jobs) ID, which this leave is related to","allOf":[{"$ref":"#/definitions/resourceId"}]},"leaveTypeId":{"title":"Leave Type","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/resourceId"}]},"startDate":{"title":"Leave Start Date","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"endDate":{"title":"Leave End Date","nullable":true,"default":null,"allOf":[{"$ref":"#/definitions/rfcDateTime"}]},"isEndDateConfirmed":{"type":"boolean","title":"End Date Confirmed","default":false,"example":false}}}},"parameters":{"collectionPage":{"name":"page","in":"query","description":"The page number","type":"integer","minimum":1},"collectionLimit":{"name":"limit","in":"query","description":"The number of items per page","type":"integer","minimum":1,"maximum":100},"resourceId":{"name":"id","in":"path","description":"The resource identifier string","required":true,"type":"string"}},"paths":{"/business-entities":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-entities_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all [Business Entities](#tag/Business-Entities).","summary":"List all Business Entities","tags":["Business Entities"],"security":[{"ApiKey":[]}]}},"/business-units":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/business-units_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all [Business Units](#tag/Business-Units) recorded in the system.","summary":"List all Business Units","tags":["Business Units"],"security":[{"ApiKey":[]}]}},"/countries":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/countries_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all configured [Countries](#g/countries).","summary":"List all Countries","tags":["Countries"],"security":[{"ApiKey":[]}]}},"/form-designs":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/form-designs_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all form designs.","summary":"List all form designs","tags":["Form Designs"],"security":[{"ApiKey":[]}]}},"/form-designs/{id}":{"get":{"parameters":[{"$ref":"#/parameters/resourceId"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/form-designs"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a single form design.","summary":"Find a form design by ID","tags":["Form Designs"],"security":[{"ApiKey":[]}]}},"/form-instances":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/form-instances_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all form instances.","summary":"List all form instances","tags":["Form Instances"],"security":[{"ApiKey":[]}]}},"/form-instances/{id}":{"get":{"parameters":[{"$ref":"#/parameters/resourceId"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/form-instances"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a single form instance.","summary":"Find a form instance by ID","tags":["Form Instances"],"security":[{"ApiKey":[]}]}},"/genders":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/genders_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all tenant-configured genders and their unique ids.","summary":"List all genders","tags":["Genders"],"security":[{"ApiKey":[]}]}},"/jobs":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobs_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all [Job](#tag/Jobs) entity records as at the current date.","summary":"List all jobs","tags":["Jobs"],"security":[{"ApiKey":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"Created Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobs"}}}},"400":{"$ref":"#/responses/errors/400"},"403":{"$ref":"#/responses/errors/403"},"500":{"$ref":"#/responses/errors/500"}},"description":"Create a job for a Person. \n\nIMPORTANT: Please note that workflows will NOT be automatically triggered as a result of creating Jobs using this API endpoint. \n\nTo trigger the workflows manually, use the intelliHR platform. \n\nAutomatic workflow triggering will be added in the future, please contact <a href=\"mailto:support@intellihr.co\">support@intellihr.co</a> with any questions.","summary":"Create a job","tags":["Jobs"],"security":[{"ApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobs_create"},"example":{"personId":"08f75a71-f725-479d-9e8b-6898f8a89eae","startDate":"2018-01-22T00:00:00+10:00","endDate":"2019-03-22T00:00:00+10:00","name":"Software Engineer","supervisorJobId":"ca052cb4-0858-4b24-893b-1b08b2bbd32f","locationId":"394e7bb8-2bf6-48e2-9dcd-df1e8ee5027d","businessUnitId":"3eebb248-4800-4e31-b675-164cfa40a0c4","businessEntityId":"57c9165a-fd31-412b-b380-bf1856b5a4fe","workTypeId":"cbbd20ef-0932-420e-ae7b-9adce959f2b3","workClassId":"8180e51d-9cc5-482e-808c-a2f21234a2d9","payGradeId":"bb8e5c70-06a4-4606-833c-8e78117676ed","fte":1,"recruitmentSourceId":"26b8d543-d7bd-441b-a3b7-412c211c1b9c","recruitementCost":1000,"currency":"AUD"}}}}}},"/jobs/{id}":{"get":{"parameters":[{"$ref":"#/parameters/resourceId"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/jobs"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Get a single Job record by UUIDv4 identifier.","summary":"Get a Job by ID","tags":["Jobs"],"security":[{"ApiKey":[]}]}},"/locations":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/locations_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all locations.","summary":"List all locations","tags":["Locations"],"security":[{"ApiKey":[]}]}},"/pay-grades":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pay-grades_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all pay grades.","summary":"List all pay grades","tags":["Pay Grades"],"security":[{"ApiKey":[]}]}},"/people":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all people.","summary":"List all people","tags":["People"],"security":[{"ApiKey":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"Created Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people"}}}},"400":{"$ref":"#/responses/errors/400"},"403":{"$ref":"#/responses/errors/403"},"500":{"$ref":"#/responses/errors/500"}},"description":"Create a person","summary":"","tags":["People"],"security":[{"ApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_create"},"examples":{"extensiveExample":{"summary":"Extensive person details","value":{"dateOfBirth":"1980-01-01","emergencyContactEmail":"johndoe@example.com","emergencyContactName":"John Doe","emergencyContactPhone":"0451 234 234","emergencyContactPhoneCountryId":"039f60d5-1b38-451a-b191-5e4b86273324","emergencyContactRelationship":"Sibling","employeeNumber":"00001","firstName":"Jane","gender":"Male","genderId":"f4692556-d023-47f4-a3bc-06d7295f797e","lastName":"Doe","preferredName":"Jen","titleId":"cc117290-a9a6-4e37-9966-4d728a6c1339","emailAddresses":[{"isPersonal":true,"isPrimary":true,"email":"brucewayne@example.com","name":"Some Email"}],"phoneNumbers":[{"isPersonal":true,"isPrimary":true,"phone":"0451 123 124","countryId":"039f60d5-1b38-451a-b191-5e4b86273324"},{"isPersonal":true,"isPrimary":true,"phone":"0451 321 421","countryId":"039f60d5-1b38-451a-b191-5e4b86273324"}]}},"minimalExample":{"summary":"Minimal person details","value":{"lastName":"Doe"}}}}}}}},"/people/{id}":{"get":{"parameters":[{"$ref":"#/parameters/resourceId"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a single person.","summary":"Find person by ID","tags":["People"],"security":[{"ApiKey":[]}]}},"/recruitment-sources":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/recruitment-sources_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all recruitment sources.","summary":"List all recruitment sources","tags":["Recruitment Sources"],"security":[{"ApiKey":[]}]}},"/titles":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/titles_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all titles.","summary":"List all titles","tags":["Titles"],"security":[{"ApiKey":[]}]}},"/trainings":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trainings_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all trainings.","summary":"List all trainings","tags":["Trainings"],"security":[{"ApiKey":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"Created Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trainings"}}}},"400":{"$ref":"#/responses/errors/400"},"403":{"$ref":"#/responses/errors/403"},"500":{"$ref":"#/responses/errors/500"}},"description":"Create a training record for a Person. \n\nIMPORTANT: Please note that workflows will NOT be automatically triggered as a result of creating Training using this API endpoint, although it will return the required information to manually trigger it. \n\nTo trigger the workflows manually, use the intelliHR platform. \n\nAutomatic workflow triggering will be added in the future, please contact <a href=\"mailto:support@intellihr.co\">support@intellihr.co</a> with any questions.","summary":"Create a training record","tags":["Trainings"],"security":[{"ApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/trainings_create_request"},"example":{"currency":"AUD","completionDate":"2019-03-22T00:00:00+10:00","cost":"100.50","hours":"10","coordinatorPersonId":"74502ff8-d2e0-4b2b-ac62-9965314d3803","jobId":"4127e93d-444e-4414-9734-541ac35fb30d","name":"Fire Safety Training","personId":"b1d0b868-c47a-4562-99f1-72b60b9d44b6","providerId":"a839d662-883f-48d6-9a81-be71ec792438","typeId":"3ad3e635-4a1b-4af3-934e-f8473d4d2124","customFields":{"text_field_api_name":{"value":"Some text value"},"numeric_field_api_name":{"value":"50"},"single_select_api_name":{"value":{"label":"Drama"}},"multi_select_api_name":{"value":{"labels":["Bananas","Apples"]}},"delete_value_api_name":{"value":null}}}}}}}},"/trainings/{id}":{"get":{"parameters":[{"$ref":"#/parameters/resourceId"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trainings"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a single training.","summary":"Find a training by ID","tags":["Trainings"],"security":[{"ApiKey":[]}]},"patch":{"parameters":[{"$ref":"#/parameters/resourceId"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/trainings"}}}},"400":{"$ref":"#/responses/errors/400"},"403":{"$ref":"#/responses/errors/403"},"500":{"$ref":"#/responses/errors/500"}},"description":"Updates only the provided data on the given training record","summary":"Update a training by ID","tags":["Trainings"],"security":[{"ApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/trainings_patch_request"},"example":{"currency":"AUD","completionDate":"2019-03-22T00:00:00+10:00","cost":"100.50","hours":"10","coordinatorPersonId":"74502ff8-d2e0-4b2b-ac62-9965314d3803","jobId":"4127e93d-444e-4414-9734-541ac35fb30d","name":"Fire Safety Training","personId":"b1d0b868-c47a-4562-99f1-72b60b9d44b6","providerId":"a839d662-883f-48d6-9a81-be71ec792438","typeId":"3ad3e635-4a1b-4af3-934e-f8473d4d2124","customFields":{"text_field_api_name":{"value":"Some text value"},"numeric_field_api_name":{"value":"50"},"single_select_api_name":{"value":{"label":"Drama"}},"multi_select_api_name":{"value":{"labels":["Bananas","Apples"]}},"delete_value_api_name":{"value":null}}}}}}},"delete":{"parameters":[{"$ref":"#/parameters/resourceId"}],"responses":{"200":{"description":"Success"},"400":{"$ref":"#/responses/errors/400"},"403":{"$ref":"#/responses/errors/403"},"500":{"$ref":"#/responses/errors/500"}},"description":"Deletes the provided training record","summary":"Delete a training by ID","tags":["Trainings"],"security":[{"ApiKey":[]}]}},"/training-types":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/training-types_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all training types.","summary":"List all training types","tags":["Training Types"],"security":[{"ApiKey":[]}]}},"/training-providers":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/training-providers_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all training providers.","summary":"List all training providers","tags":["Training Providers"],"security":[{"ApiKey":[]}]}},"/webhook-events":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook-events_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all webhook events.","summary":"List all webhook events","tags":["Webhook Events"],"security":[{"ApiKey":[]}]}},"/webhooks":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all webhooks.","summary":"List all webhooks","tags":["Webhooks"],"security":[{"ApiKey":[]}]},"post":{"parameters":[],"responses":{"201":{"description":"Created Successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks"}}}},"400":{"$ref":"#/responses/errors/400"},"403":{"$ref":"#/responses/errors/403"},"500":{"$ref":"#/responses/errors/500"}},"description":"","summary":"Create a webhook","tags":["Webhooks"],"security":[{"ApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_create"},"examples":{"extensiveExample":{"summary":"Extensive webhook details","value":{"url":"http://example.com","webhookEventId":"37a801d7-404c-4bba-96ca-1553ac563769","isEnabled":true,"source":"custom"}},"minimalExample":{"summary":"Minimal webhook details","value":{"url":"http://example.com","webhookEventId":"37a801d7-404c-4bba-96ca-1553ac563769"}}}}}}}},"/webhooks/{id}":{"get":{"parameters":[{"$ref":"#/parameters/resourceId"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a single webhook","summary":"Find a webhook by ID","tags":["Webhooks"],"security":[{"ApiKey":[]}]},"patch":{"parameters":[{"$ref":"#/parameters/resourceId"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks"}}}},"400":{"$ref":"#/responses/errors/400"},"403":{"$ref":"#/responses/errors/403"},"500":{"$ref":"#/responses/errors/500"}},"description":"","summary":"Patch a webhook","tags":["Webhooks"],"security":[{"ApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_patch"},"examples":{"extensiveExample":{"summary":"Extensive webhook details","value":{"url":"http://example.com","webhookEventId":"37a801d7-404c-4bba-96ca-1553ac563769","isEnabled":true,"source":"custom"}},"minimalExample":{"summary":"Minimal webhook details","value":{}}}}}}},"delete":{"parameters":[{"$ref":"#/parameters/resourceId"}],"responses":{"200":{"description":"Success"},"400":{"$ref":"#/responses/errors/400"},"403":{"$ref":"#/responses/errors/403"},"500":{"$ref":"#/responses/errors/500"}},"description":"Deletes the provided webhook","summary":"Delete a webhook by ID","tags":["Webhooks"],"security":[{"ApiKey":[]}]}},"/work-classes":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/work-classes_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all work classes.","summary":"List all work classes","tags":["Work Classes"],"security":[{"ApiKey":[]}]}},"/work-types":{"get":{"parameters":[{"$ref":"#/parameters/collectionLimit"},{"$ref":"#/parameters/collectionPage"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/work-types_list"}}}},"500":{"$ref":"#/responses/errors/500"}},"description":"Returns a list of all work types.","summary":"List all work types","tags":["Work Types"],"security":[{"ApiKey":[]}]}}},"openapi":"3.0.2","tags":[{"name":"Business Entities","description":"Business Entities represent the legal entities exist within the organisation. When creating a Job, a Business Entity id must be provided. A Business Entity can be used as a filter for automation logic (eg Pulse configuration) and as a dimension in the analytics tools."},{"name":"Business Units","description":"The administrative units that exist within the organisation. Used to render the org chart business unit view. For example, \"Finance\", \"HR\", or \"Information Technology\""},{"name":"Countries","description":"Countries are not configurable in the system and may be updated over time. Referencing a country by its UUID should never need updating."},{"name":"Form Designs","description":"Form designs are used in the system to describe the layout and settings for a form to send to people."},{"name":"Form Instances","description":"Form instances represent the tasks to complete a form issued to a given person."},{"name":"Genders","description":"Genders are configurable in the system and so must be specified by reference to the UUID. Default values include `Male`, `Female` and `Other`. These are used for analytical filters to show gender as a dimension."},{"name":"Jobs","description":"The Job object is the core data object for past, current and future roles that a Person holds in the organisation. A Person can have more than one Job at a point in time to represent secondment / role sharing. Each Job has it's own set of attributes such as Supervisor, Position Title or Remuneration which are themselves effective dated. This allows us to model the full history of every Job attribute for date based queries. Support for date based queries in this API is planned but not yet available. Please contact <a href=\"mailto:support@intellihr.co\">support@intellihr.co</a> with any questions."},{"name":"Locations","description":"Locations can be configured as text strings with parent -> child relationships. For example, `Australia` -> `Brisbane` -> `Spring Hill Head Office`. These locations are used for filtering in analytics."},{"name":"Pay Grades","description":"Pay Grades are optional attributes applied to a job to provide a salary range for analytical purposes. These are configurable for admins in the intelliHR application."},{"name":"People","description":"People represent the base objects in the intelliHR data model. All past, present and future employees should be created as a Person and then have a Job created which references that Person object. Contact information for the employee (eg emergency contact, phone numbers, postal addresses, email addresses, etc) is referenced to the Person object. Jobs (and their attributes) are effective dated (start and end dates) but People are not."},{"name":"Recruitment Sources","description":"Recruitment sources refer to the origin of this employee, such as a job board or a recruitment agency. These are configured as text strings in the intelliHR application and are used as filters for analytical purposes."},{"name":"Titles","description":"Titles are used on [People](#tag/People) to describe the title they wish to be referred to by. E.g. Mr, or Ms."},{"name":"Trainings","description":"Trainings are used in the system to store details about individual training events"},{"name":"Training Types","description":"Trainings types are used in the system to document the category of a [Training](#tag/Trainings) record"},{"name":"Training Providers","description":"Trainings providers are used in the system to document what provided the [Training](#tag/trainings)"},{"name":"Webhook Events","description":"Webhook events are events which will be triggered when their corresponding action is done.\n\n  Webhooks are currently in alpha status and may be changed at any time. There are listed here as a technical preview."},{"name":"Webhooks","description":"Webhooks are used in the system to allow users to subscribe to a specific webhook event, such as a person updated event or a job updated event. When the event is triggered, the system will send a related request to the webhook endpoint, which can be specified when creating one.\n\nWebhooks are currently in alpha status and may be changed at any time. There are listed here as a technical preview."},{"name":"Work Classes","description":"Work Classes are a sub-class of Work Types. For example, the `Permanent` Work Type has both `Full-Time` and `Part-Time` Work Classes. These are used for to configure automation and analytics filters.  "},{"name":"Work Types","description":"Work Types represent the primary work classification for a job. For example `Permanent`, `Fixed Contract`, `Unpaid` or `Temporary/Casual`. This attribute is always used with the Work Class attribute which is a sub class of Work Type."}]}