Employment HeroRetrieves a paginated list of all induction content items belonging to the organisation. Items are ordered by creation date and include sharing details for each record.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contentsPath Parameters
The ID of the organisation.
Query Parameters
Current page index
11Number of items per page
20100Response Body
Returns a paginated list of induction content items belonging to the organisation.
The unique identifier of the induction content item.
The name of the induction content item.
The type of the induction content item.
Whether employee acknowledgement is required for this item.
The renewal cadence. Only present when required is true.
Whether this item is shared with all members of the organisation.
A human-readable description of who the item is shared with (e.g. "All employees" or a list of group names).
The individual sharing records for this item.
Whether the authenticated caller can edit this item.
Whether the authenticated caller can delete this item.
Whether the authenticated caller can share this item.
Additional metadata about the item.
File content details. Only present for FileInductionContent items; null for VideoInductionContent and LinkInductionContent.
Current page index
11Number of items per page
20100Total items
Total pages
Example
curl -X GET \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contents" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "items": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Employee Handbook", "type": "FileInductionContent", "required": true, "renewal_type": "yearly", "shared_all": true, "shared_to_text": "All employees", "shared_induction_contents": [], "editable": true, "deletable": true, "shareable": true, "metadata": { "is_ceis_document": false }, "content": { "url": "https://cdn.employmenthero.com/files/employee-handbook.pdf?signature=abc123", "file_name": "employee-handbook.pdf" } }, { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Workplace Safety Training Video", "type": "VideoInductionContent", "required": false, "renewal_type": null, "shared_all": false, "shared_to_text": "Engineering", "shared_induction_contents": [ { "resource_type": "Team", "resource_id": "c3d4e5f6-a7b8-9012-cdef-123456789012" } ], "editable": true, "deletable": true, "shareable": true, "metadata": { "is_ceis_document": false }, "content": null } ], "page_index": 1, "item_per_page": 20, "total_items": 2, "total_pages": 1 }}Retrieves a single induction content item by its ID. For FileInductionContent items, the response includes a presigned content.url valid for approximately 15 minutes.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contents/:induction_content_idPath Parameters
The ID of the organisation.
The ID of the induction content item.
Response Body
Returns the induction content item including its sharing configuration, editability flags, and file content URL (for file-based items).
The unique identifier of the induction content item.
The name of the induction content item.
The type of the induction content item.
Whether employee acknowledgement is required for this item.
The renewal cadence. Only present when required is true.
Whether this item is shared with all members of the organisation.
A human-readable description of who the item is shared with (e.g. "All employees" or a list of group names).
The individual sharing records for this item.
Whether the authenticated caller can edit this item.
Whether the authenticated caller can delete this item.
Whether the authenticated caller can share this item.
Additional metadata about the item.
File content details. Only present for FileInductionContent items; null for VideoInductionContent and LinkInductionContent.
Example
curl -X GET \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contents/:induction_content_id" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Employee Handbook", "type": "FileInductionContent", "required": true, "renewal_type": "yearly", "shared_all": true, "shared_to_text": "All employees", "shared_induction_contents": [], "editable": true, "deletable": true, "shareable": true, "metadata": { "is_ceis_document": false }, "content": { "url": "https://cdn.employmenthero.com/files/employee-handbook.pdf?signature=abc123", "file_name": "employee-handbook.pdf" } }}Uploads a file for use as a FileInductionContent item. This is the first step of the two-step file creation flow: upload the file here to obtain a file_id, then pass that file_id to the Create Induction Content or Update Induction Content endpoint.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contents/file_uploadsPath Parameters
The ID of the organisation.
Request Body
The file to upload via multipart/form-data. Maximum 10 MB. Accepted formats: PDF, DOC, DOCX.
Response Body
Returns an opaque file_id handle and the uploaded file URL on HTTP 201. Use the file_id immediately in a create or update request — the handle has a limited lifetime.
An opaque file handle to use in subsequent create or update requests. The handle has a limited lifetime governed by the Files service.
The URL of the uploaded file.
The sanitized filename of the uploaded file.
Example
curl -X POST \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contents/file_uploads" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \ -F "file=@/path/to/employee-handbook.pdf"Response
{ "data": { "file_id": "fil_abc123def456ghi789", "url": "https://cdn.employmenthero.com/files/employee-handbook.pdf", "name": "employee-handbook.pdf" }}Creates a new induction content item for the organisation. Three types are supported: file-based (FileInductionContent), YouTube video (VideoInductionContent), and external link (LinkInductionContent). For file-based items, upload the file first using the Upload Induction Content File endpoint to obtain a file_id. The created item is not shared with any members until you call the Share Induction Content endpoint.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contentsPath Parameters
The ID of the organisation.
Request Body
The type of induction content to create.
The name of the induction content item.
Whether employee acknowledgement is required. Defaults to false.
The renewal cadence. Required when required is true. Must be omitted or null when required is false.
The file handle returned by POST .../file_uploads. Required for FileInductionContent items. Obtain this by uploading a file first.
The YouTube URL for VideoInductionContent, or the http:///https:// URL for LinkInductionContent. Not used for FileInductionContent.
Response Body
Returns the created induction content item on HTTP 201. The item is not shared with any members until a subsequent share request is made.
The unique identifier of the induction content item.
The name of the induction content item.
The type of the induction content item.
Whether employee acknowledgement is required for this item.
The renewal cadence. Only present when required is true.
Whether this item is shared with all members of the organisation.
A human-readable description of who the item is shared with (e.g. "All employees" or a list of group names).
The individual sharing records for this item.
Whether the authenticated caller can edit this item.
Whether the authenticated caller can delete this item.
Whether the authenticated caller can share this item.
Additional metadata about the item.
File content details. Only present for FileInductionContent items; null for VideoInductionContent and LinkInductionContent.
Example
curl -X POST \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contents" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \ -H "Content-Type: application/json" \ -d '{ "type": "FileInductionContent", "name": "Employee Handbook", "required": true, "renewal_type": "yearly", "file_id": "fil_abc123def456ghi789" }'Response
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Employee Handbook", "type": "FileInductionContent", "required": true, "renewal_type": "yearly", "shared_all": true, "shared_to_text": "All employees", "shared_induction_contents": [], "editable": true, "deletable": true, "shareable": true, "metadata": { "is_ceis_document": false }, "content": { "url": "https://cdn.employmenthero.com/files/employee-handbook.pdf?signature=abc123", "file_name": "employee-handbook.pdf" } }}Updates an induction content item. Only the fields provided in the request body are updated; all other fields remain unchanged. Replacing the file of a FileInductionContent item by providing a new file_id clears all existing employee acknowledgements — the response includes an acknowledgements_cleared count. Partners should surface this consequence to end-users before calling this endpoint with a new file.
CEIS (Casual Employment Information Statement) documents managed by Employment Hero can only have their required flag updated; any other field change returns a 422.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contents/:induction_content_idPath Parameters
The ID of the organisation.
The ID of the induction content item to update.
Request Body
The type of induction content.
The name of the induction content item.
Whether employee acknowledgement is required.
The renewal cadence. Required when required is true. Must be omitted or null when required is false.
A new file handle from POST .../file_uploads. Providing a new file_id replaces the existing file and clears all employee acknowledgements — see acknowledgements_cleared in the response.
The YouTube URL for VideoInductionContent, or the http:///https:// URL for LinkInductionContent.
Response Body
Returns the updated induction content item. When a new file is provided, acknowledgements_cleared indicates how many employee acknowledgements were reset and employees must re-acknowledge the item.
The unique identifier of the induction content item.
The name of the induction content item.
The type of the induction content item.
Whether employee acknowledgement is required for this item.
The renewal cadence. Only present when required is true.
Whether this item is shared with all members of the organisation.
A human-readable description of who the item is shared with (e.g. "All employees" or a list of group names).
The individual sharing records for this item.
Whether the authenticated caller can edit this item.
Whether the authenticated caller can delete this item.
Whether the authenticated caller can share this item.
Additional metadata about the item.
File content details. Only present for FileInductionContent items; null for VideoInductionContent and LinkInductionContent.
The number of employee acknowledgements cleared by replacing the file. Zero when the file was not replaced or the item has no prior acknowledgements.
Example
curl -X PATCH \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contents/:induction_content_id" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \ -H "Content-Type: application/json" \ -d '{ "name": "Employee Handbook v2", "file_id": "fil_xyz789abc123def456" }'Response
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Employee Handbook v2", "type": "FileInductionContent", "required": true, "renewal_type": "yearly", "shared_all": true, "shared_to_text": "All employees", "shared_induction_contents": [], "editable": true, "deletable": true, "shareable": true, "metadata": { "is_ceis_document": false }, "content": { "url": "https://cdn.employmenthero.com/files/employee-handbook-v2.pdf?signature=xyz789", "file_name": "employee-handbook-v2.pdf" }, "acknowledgements_cleared": 12 }}Permanently deletes an induction content item and all associated sharing records and employee acknowledgements. Employment Hero-owned documents cannot be deleted and return 403.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contents/:induction_content_idPath Parameters
The ID of the organisation.
The ID of the induction content item to delete.
Response Body
Returns HTTP 204 No Content on success. The item, all sharing records, and all employee acknowledgements are permanently removed.
Example
curl -X DELETE \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/induction_contents/:induction_content_id" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
This endpoint does not return a response body.