Employment HeroRetrieve a paginated list of assets belonging to an organisation. Results can be filtered by status, assigned employee, category name, or a free-text search across asset name and asset code.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/assetsPath Parameters
The ID of the organisation.
Query Parameters
Current page index
11Number of items per page
20100Filter assets by status. One of: available, in_use, unavailable.
Filter to assets currently assigned to this employee UUID.
Filter assets by category name.
Search assets by name or asset code.
Response Body
A paginated list of assets belonging to the organisation. Each entry includes assignment details, categories, custom field values, and attached file URLs.
Unique identifier of the asset.
Display name of the asset.
Unique code used to identify the asset within the organisation.
Current lifecycle status of the asset.
Details of the current assignment, or null if the asset is not currently assigned.
List of URLs for files attached to the asset.
Date the asset was purchased, in ISO 8601 format (YYYY-MM-DD).
Purchase price of the asset.
ISO 4217 currency code for the purchase amount (e.g. AUD, USD).
Free-text notes or additional details about the asset.
Date the asset was last returned by an assignee, in ISO 8601 format (YYYY-MM-DD).
Date the asset was disposed of, in ISO 8601 format (YYYY-MM-DD).
Reason recorded for the asset disposal.
Additional notes recorded at the time of disposal.
Asset categories the asset belongs to.
Custom field values defined for the asset.
Timestamp when the asset was created, in ISO 8601 format.
Timestamp when the asset was last updated, in ISO 8601 format.
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/assets" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "items": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "MacBook Pro 16\"", "asset_code": "AST-0042", "status": "in_use", "current_assignment": { "member_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "member_name": "Jane Smith", "assigned_date": "2025-03-01" }, "file_urls": [], "purchase_date": "2024-11-15", "purchase_amount": 3499, "currency": "AUD", "additional_details": "Engineering team laptop — replaced 2022 model.", "last_returned_date": null, "disposal_date": null, "disposal_reason": null, "disposal_additional_details": null, "categories": [ { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "name": "Laptop" } ], "custom_fields": [ { "id": "d4e5f6a7-b8c9-0123-defa-234567890123", "name": "Serial Number", "field_type": "text", "value": "C02XL0VLJGH5" } ], "created_at": "2024-11-15T09:00:00.000Z", "updated_at": "2025-03-01T14:30:00.000Z" } ], "page_index": 1, "item_per_page": 20, "total_items": 1, "total_pages": 1 }}Retrieves the full details of a specific asset by its unique identifier. Use this endpoint to fetch a single asset's complete information, including its current assignment, categories, custom field values, and attached file URLs.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/assets/:asset_idPath Parameters
The ID of the organisation.
The ID of the asset to retrieve.
Response Body
The full details of the specified asset, including assignment information, categories, custom field values, and attached file URLs.
Unique identifier of the asset.
Display name of the asset.
Unique code used to identify the asset within the organisation.
Current lifecycle status of the asset.
Details of the current assignment, or null if the asset is not currently assigned.
List of URLs for files attached to the asset.
Date the asset was purchased, in ISO 8601 format (YYYY-MM-DD).
Purchase price of the asset.
ISO 4217 currency code for the purchase amount (e.g. AUD, USD).
Free-text notes or additional details about the asset.
Date the asset was last returned by an assignee, in ISO 8601 format (YYYY-MM-DD).
Date the asset was disposed of, in ISO 8601 format (YYYY-MM-DD).
Reason recorded for the asset disposal.
Additional notes recorded at the time of disposal.
Asset categories the asset belongs to.
Custom field values defined for the asset.
Timestamp when the asset was created, in ISO 8601 format.
Timestamp when the asset was last updated, in ISO 8601 format.
Example
curl -X GET \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/assets/:asset_id" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "MacBook Pro 16\"", "asset_code": "AST-0042", "status": "in_use", "current_assignment": { "member_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "member_name": "Jane Smith", "assigned_date": "2025-03-01" }, "file_urls": [], "purchase_date": "2024-11-15", "purchase_amount": 3499, "currency": "AUD", "additional_details": "Engineering team laptop — replaced 2022 model.", "last_returned_date": null, "disposal_date": null, "disposal_reason": null, "disposal_additional_details": null, "categories": [ { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "name": "Laptop" } ], "custom_fields": [ { "id": "d4e5f6a7-b8c9-0123-defa-234567890123", "name": "Serial Number", "field_type": "text", "value": "C02XL0VLJGH5" } ], "created_at": "2024-11-15T09:00:00.000Z", "updated_at": "2025-03-01T14:30:00.000Z" }}Creates a new asset record in the organisation. You can optionally assign the asset to a member on creation by including the assignment object in the request body.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/assetsPath Parameters
The ID of the organisation.
Request Body
Display name of the asset.
Unique code for the asset within the organisation (case-insensitive).
Date of purchase in ISO 8601 format (YYYY-MM-DD).
Purchase price of the asset. Must be greater than or equal to 0.
ISO 4217 currency code for the purchase amount (e.g. AUD, USD).
Free-text notes or additional details about the asset.
Category names to assign to the asset.
IDs of previously uploaded files to attach to the asset.
Optional assignment to immediately assign the asset to a member on creation.
Custom field values to set on the asset.
Response Body
The newly created asset with all its details.
Unique identifier of the asset.
Display name of the asset.
Unique code used to identify the asset within the organisation.
Current lifecycle status of the asset.
Details of the current assignment, or null if the asset is not currently assigned.
List of URLs for files attached to the asset.
Date the asset was purchased, in ISO 8601 format (YYYY-MM-DD).
Purchase price of the asset.
ISO 4217 currency code for the purchase amount (e.g. AUD, USD).
Free-text notes or additional details about the asset.
Date the asset was last returned by an assignee, in ISO 8601 format (YYYY-MM-DD).
Date the asset was disposed of, in ISO 8601 format (YYYY-MM-DD).
Reason recorded for the asset disposal.
Additional notes recorded at the time of disposal.
Asset categories the asset belongs to.
Custom field values defined for the asset.
Timestamp when the asset was created, in ISO 8601 format.
Timestamp when the asset was last updated, in ISO 8601 format.
Example
curl -X POST \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/assets" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \ -H "Content-Type: application/json" \ -d '{ "name": "MacBook Pro 16\"", "asset_code": "AST-0042", "purchase_date": "2024-11-15", "purchase_amount": 3499, "currency": "AUD", "additional_details": "Engineering team laptop.", "asset_category_names": [ "Laptop" ], "file_ids": [], "assignment": { "member_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "assign_date": "2024-11-15", "notify_assignment": false }, "custom_fields": [ { "custom_field_id": "d4e5f6a7-b8c9-0123-defa-234567890123", "value": "C02XL0VLJGH5" } ] }'Response
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "MacBook Pro 16\"", "asset_code": "AST-0042", "status": "in_use", "current_assignment": { "member_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "member_name": "Jane Smith", "assigned_date": "2025-03-01" }, "file_urls": [], "purchase_date": "2024-11-15", "purchase_amount": 3499, "currency": "AUD", "additional_details": "Engineering team laptop — replaced 2022 model.", "last_returned_date": null, "disposal_date": null, "disposal_reason": null, "disposal_additional_details": null, "categories": [ { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "name": "Laptop" } ], "custom_fields": [ { "id": "d4e5f6a7-b8c9-0123-defa-234567890123", "name": "Serial Number", "field_type": "text", "value": "C02XL0VLJGH5" } ], "created_at": "2024-11-15T09:00:00.000Z", "updated_at": "2025-03-01T14:30:00.000Z" }}Partially updates an existing asset. Only fields included in the request body are modified; omitted fields are left unchanged.
To update custom field values, include only the custom_field_id and value pairs you want to change. Pass value: null to clear a field's value. Omitting custom_fields entirely leaves all existing custom field values untouched.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/assets/:asset_idPath Parameters
The ID of the organisation.
The ID of the asset to update.
Request Body
Display name of the asset.
Unique code for the asset within the organisation (case-insensitive).
Date of purchase in ISO 8601 format (YYYY-MM-DD).
Purchase price of the asset. Must be greater than or equal to 0.
ISO 4217 currency code for the purchase amount (e.g. AUD, USD).
Free-text notes or additional details about the asset.
Category names to assign to the asset. Replaces the existing set of categories.
IDs of previously uploaded files to attach to the asset.
Custom field values to update. Only the fields provided are updated; others remain unchanged. Pass value: null to clear a specific field.
Response Body
The updated asset with all its current details.
Unique identifier of the asset.
Display name of the asset.
Unique code used to identify the asset within the organisation.
Current lifecycle status of the asset.
Details of the current assignment, or null if the asset is not currently assigned.
List of URLs for files attached to the asset.
Date the asset was purchased, in ISO 8601 format (YYYY-MM-DD).
Purchase price of the asset.
ISO 4217 currency code for the purchase amount (e.g. AUD, USD).
Free-text notes or additional details about the asset.
Date the asset was last returned by an assignee, in ISO 8601 format (YYYY-MM-DD).
Date the asset was disposed of, in ISO 8601 format (YYYY-MM-DD).
Reason recorded for the asset disposal.
Additional notes recorded at the time of disposal.
Asset categories the asset belongs to.
Custom field values defined for the asset.
Timestamp when the asset was created, in ISO 8601 format.
Timestamp when the asset was last updated, in ISO 8601 format.
Example
curl -X PATCH \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/assets/:asset_id" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \ -H "Content-Type: application/json" \ -d '{ "name": "MacBook Pro 16\"", "asset_code": "AST-0042", "purchase_amount": 3499, "currency": "AUD", "custom_fields": [ { "custom_field_id": "d4e5f6a7-b8c9-0123-defa-234567890123", "value": "C02XL0VLJGH5" } ] }'Response
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "MacBook Pro 16\"", "asset_code": "AST-0042", "status": "in_use", "current_assignment": { "member_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "member_name": "Jane Smith", "assigned_date": "2025-03-01" }, "file_urls": [], "purchase_date": "2024-11-15", "purchase_amount": 3499, "currency": "AUD", "additional_details": "Engineering team laptop — replaced 2022 model.", "last_returned_date": null, "disposal_date": null, "disposal_reason": null, "disposal_additional_details": null, "categories": [ { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "name": "Laptop" } ], "custom_fields": [ { "id": "d4e5f6a7-b8c9-0123-defa-234567890123", "name": "Serial Number", "field_type": "text", "value": "C02XL0VLJGH5" } ], "created_at": "2024-11-15T09:00:00.000Z", "updated_at": "2025-03-01T14:30:00.000Z" }}Permanently delete an asset from the organisation's asset register.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/assets/:asset_idPath Parameters
The ID of the organisation.
The ID of the asset to delete.
Response Body
Returns HTTP 204 No Content on success. The asset and all its history are permanently removed. This action cannot be undone.
Example
curl -X DELETE \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/assets/:asset_id" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"Response
This endpoint does not return a response body.
Transfers an asset from its current assignee to a different employee in a single atomic operation. The previous assignment is closed with the returned_at date and a new assignment is opened with the assign_date.
https:/api.employmenthero.com/api/v1/organisations/:organisation_id/assets/:asset_id/reassignPath Parameters
The ID of the organisation.
The ID of the asset to reassign.
Request Body
UUID of the employee to assign the asset to.
Date the asset is returned from the current assignee, in ISO 8601 format (YYYY-MM-DD). Defaults to today.
Date the asset is assigned to the new employee, in ISO 8601 format (YYYY-MM-DD). Must be on or after returned_at. Defaults to today.
Whether to send an assignment notification email to the new assignee. Defaults to false.
Response Body
The reassigned asset with updated status and current assignment details.
Unique identifier of the asset.
Display name of the asset.
Unique code used to identify the asset within the organisation.
Current lifecycle status of the asset.
Details of the current assignment, or null if the asset is not currently assigned.
List of URLs for files attached to the asset.
Date the asset was purchased, in ISO 8601 format (YYYY-MM-DD).
Purchase price of the asset.
ISO 4217 currency code for the purchase amount (e.g. AUD, USD).
Free-text notes or additional details about the asset.
Date the asset was last returned by an assignee, in ISO 8601 format (YYYY-MM-DD).
Date the asset was disposed of, in ISO 8601 format (YYYY-MM-DD).
Reason recorded for the asset disposal.
Additional notes recorded at the time of disposal.
Asset categories the asset belongs to.
Custom field values defined for the asset.
Timestamp when the asset was created, in ISO 8601 format.
Timestamp when the asset was last updated, in ISO 8601 format.
Example
curl -X POST \ "https://api.employmenthero.com/api/v1/organisations/:organisation_id/assets/:asset_id/reassign" \ -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \ -H "Content-Type: application/json" \ -d '{ "member_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "returned_at": "2025-03-01", "assign_date": "2025-03-01", "notify_assignment": false }'Response
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "MacBook Pro 16\"", "asset_code": "AST-0042", "status": "in_use", "current_assignment": { "member_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "member_name": "Jane Smith", "assigned_date": "2025-03-01" }, "file_urls": [], "purchase_date": "2024-11-15", "purchase_amount": 3499, "currency": "AUD", "additional_details": "Engineering team laptop — replaced 2022 model.", "last_returned_date": null, "disposal_date": null, "disposal_reason": null, "disposal_additional_details": null, "categories": [ { "id": "c3d4e5f6-a7b8-9012-cdef-123456789012", "name": "Laptop" } ], "custom_fields": [ { "id": "d4e5f6a7-b8c9-0123-defa-234567890123", "name": "Serial Number", "field_type": "text", "value": "C02XL0VLJGH5" } ], "created_at": "2024-11-15T09:00:00.000Z", "updated_at": "2025-03-01T14:30:00.000Z" }}