Asset Category

Get Asset Categories

Returns a paginated list of asset categories for the organisation. Use the optional search parameter to filter categories by name.

GET

https://api.employmenthero.com/api/v1/organisations/:organisation_id/asset_categories

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

Query Parameters

searchstring

Filter categories by name.

page_indexnumber

Current page index

Default1

Min1

item_per_pagenumber

Number of items per page

Default20

Max100

Response Body

A paginated list of asset categories for the organisation.

dataobject

itemsobject[]

iduuid

Unique identifier of the asset category.

namestring

Display name of the asset category.

page_indexnumber

Current page index

Default1

Min1

item_per_pagenumber

Number of items per page

Default20

Max100

total_itemsnumber

Total items

total_pagesnumber

Total pages

Example

curl -X GET \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/asset_categories" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"

Response

{  "data": {    "items": [      {        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",        "name": "Laptop"      }    ],    "page_index": 1,    "item_per_page": 20,    "total_items": 1,    "total_pages": 1  }}

Create Asset Category

Creates a new asset category for the organisation. Category names must be unique within the organisation.

POST

https://api.employmenthero.com/api/v1/organisations/:organisation_id/asset_categories

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

Request Body

namestringrequired

Display name of the asset category. Must be unique within the organisation.

Response Body

The newly created asset category.

dataobject

iduuid

Unique identifier of the asset category.

namestring

Display name of the asset category.

Example

curl -X POST \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/asset_categories" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \  -H "Content-Type: application/json" \  -d '{    "name": "Laptop"  }'

Response

{  "data": {    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",    "name": "Laptop"  }}

Update Asset Category

Updates an existing asset category.

PATCH

https://api.employmenthero.com/api/v1/organisations/:organisation_id/asset_categories/:asset_category_id

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

asset_category_iduuidrequired

The ID of the asset category to rename.

Request Body

namestringrequired

New display name for the asset category. Must be unique within the organisation.

Response Body

The updated asset category with its new name.

dataobject

iduuid

Unique identifier of the asset category.

namestring

Display name of the asset category.

Example

curl -X PATCH \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/asset_categories/:asset_category_id" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ" \  -H "Content-Type: application/json" \  -d '{    "name": "Laptop"  }'

Response

{  "data": {    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",    "name": "Laptop"  }}

Delete Asset Category

Permanently removes an asset category from the organisation. Assets that previously used the category remain intact with their other categories unchanged.

DELETE

https://api.employmenthero.com/api/v1/organisations/:organisation_id/asset_categories/:asset_category_id

Path Parameters

organisation_iduuidrequired

The ID of the organisation.

asset_category_iduuidrequired

The ID of the asset category to delete.

Response Body

Returns HTTP 204 No Content on success. The category is permanently removed. Assets that used it remain intact with their other categories unchanged.

Example

curl -X DELETE \  "https://api.employmenthero.com/api/v1/organisations/:organisation_id/asset_categories/:asset_category_id" \  -H "Authorization: Bearer AUXJ3123xyrj123fdsjkl124aAJKQ"

Response

This endpoint does not return a response body.