Homebox
App · 31 actions
Keep your Homebox home inventory up to date from anywhere: add and find items, record purchases, warranties and serial numbers, attach receipts and photos, and log maintenance. Start a workflow when an item is added or changed, a warranty is about to run out, maintenance is due or something is running low.
Actions
| Action | What it does |
|---|---|
| Add maintenance entry | Add an entry to an item's maintenance log: something scheduled for a day, or something already done, with what it cost. |
| Change item quantity | Set how many of an item there are, or add to or take from the count, such as when a box of filters is used. |
| Create item | Add an item to the inventory, with where it's kept, its tags and quantity, and its purchase, warranty and serial number if you have them. |
| Create location | Add a location, such as a room, a shelf or a box, at the top or inside another location. |
| Create tag | Add a tag to sort items by, such as Electronics, with a colour and inside another tag if you like. |
| Delete attachment | Remove a file or photo from an item. |
| Delete item | Delete an item for good, with its attachments and maintenance log. |
| Delete location | Delete a location. |
| Delete maintenance entry | Delete an entry from an item's maintenance log. |
| Delete tag | Delete a tag. |
| Download attachment | Get one of an item's attachments as a file a later step can use, such as a receipt to email. |
| Duplicate item | Make a copy of an item in the same location with the same tags and details, such as for a second one bought. |
| Export items as CSV | Get everything in the collection as CSV in Homebox's own format, as text and as rows, such as for a backup or an insurance list. |
| Find expiring warranties | List the items whose warranty runs out within the days you choose, soonest first, with a summary ready for a message. |
| Find items | Search the inventory by words (names, descriptions, serial and model numbers, notes, tags and custom fields), by location and by tags. |
| Get item | Get an item with everything Homebox keeps about it: where it is, its purchase and warranty, serial number, custom fields and attachments. |
| Get item by asset ID | Look up the item with an asset ID, such as one read from its label. |
| Get location | Get a location with the locations and items directly in it and what those items cost. |
| Get statistics | Get the collection's totals (items, locations, tags, what it all cost, items under warranty) and its value by location and by tag. |
| Get tag | Get a tag with the tags inside it and how many items carry it. |
| Import items from CSV | Add items from CSV in Homebox's own format (a header row with HB.name, and columns such as HB.location, HB.quantity and HB.tags). |
| List attachments | List the files and photos attached to an item. |
| List item maintenance | Get an item's maintenance log: what's scheduled, what was done and what it cost. |
| List locations | List every location, each with its path such as Garage / Tool shelf, and as an indented tree. |
| List scheduled maintenance | List maintenance across every item: what's scheduled and not done yet (optionally only what's due soon), what was done, or both. |
| List tags | List every tag (called labels in older versions of Homebox). |
| Update item | Change an item: move it, retag it, record its purchase, warranty or sale, set custom fields, or archive it. |
| Update location | Rename or describe a location, or move it inside another. |
| Update maintenance entry | Change a maintenance entry, such as marking it done with the day and the cost, or moving it to another day. |
| Update tag | Rename, describe or recolour a tag, or move it inside another. |
| Upload attachment | Attach a file to an item, such as a photo, a receipt, a manual or a warranty card. |
Add maintenance entry
Add an entry to an item's maintenance log: something scheduled for a day, or something already done, with what it cost.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
- Name
nametextRequired - What the maintenance is, such as Replace water filter.
- Description
descriptiontext - Notes about it.
- Scheduled date
scheduled_datedate - The day it's due. Give this, a completed date, or both.
- Completed date
completed_datedate - The day it was done.
- Cost
costnumber - What it cost.From 0 to 1000000000.
Outputs
completed_datetext- When it was done (YYYY-MM-DD), blank when not done
costnumber- What it cost
days_until_duenumber- Days until it's due (negative when overdue); empty when done or not scheduled
descriptiontext- Notes about it
idtext- The entry's ID, which other Homebox steps take
item_idtext- The ID of the item it's for
item_nametext- The name of the item it's for
linktext- Where the item's maintenance log opens in Homebox
nametext- What the maintenance is
scheduled_datetext- When it's due (YYYY-MM-DD), blank when not scheduled
statustext- scheduled or completed
Example output
{
"completed_date": "",
"cost": 39.9,
"days_until_due": 12,
"description": "Use the genuine filter",
"id": "016b4bbb-d482-4e99-9eee-5f01d30d73b4",
"item_id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"item_name": "Fridge",
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27/maintenance",
"name": "Replace water filter",
"scheduled_date": "2026-12-01",
"status": "scheduled"
}Change item quantity
Set how many of an item there are, or add to or take from the count, such as when a box of filters is used.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
- Set quantity to
quantitynumber - The new quantity. Leave blank to add or take away instead.From 0 to 1000000.
- Change by
change_bynumber - How many to add, or to take away with a minus, such as -1.From -1000000 to 1000000.
Outputs
archivedtrue/false- Whether it's archived
asset_idtext- Its asset ID, such as 000-012 (blank when it has none)
attachmentslist- Its files and photos
created_attext- When it was added
custom_fieldsobject- Its custom fields, by name
descriptiontext- Its description
idtext- The item's ID, which other Homebox steps take
insuredtrue/false- Whether it's marked as insured
lifetime_warrantytrue/false- Whether it has a lifetime warranty
linktext- Where the item opens in Homebox
locationtext- The location it's in, such as Garage (blank when none)
location_idtext- That location's ID
manufacturertext- Who made it
model_numbertext- Its model number
nametext- The item's name
notestext- Notes kept on it
previous_quantitynumber- How many there were before the change
purchase_datetext- When it was bought (YYYY-MM-DD), blank when not set
purchase_fromtext- Where it was bought
purchase_pricenumber- What one cost
quantitynumber- How many there are
serial_numbertext- Its serial number
sold_datetext- When it was sold (YYYY-MM-DD), blank when it wasn't
sold_notestext- Notes about the sale
sold_pricenumber- What it sold for
sold_totext- Who it was sold to
tag_idslist- The IDs of its tags
tagslist- The names of its tags
total_valuenumber- The purchase price times the quantity
updated_attext- When it was last changed
warranty_detailstext- Notes about the warranty
warranty_expirestext- When its warranty runs out (YYYY-MM-DD), blank when not set
Example output
{
"archived": false,
"asset_id": "000-012",
"attachments": [
{
"content_type": "application/pdf",
"created_at": "2026-01-15T09:31:00Z",
"id": "39c9a96c-ab99-4c65-ac96-9f4c643d78d4",
"primary": false,
"title": "receipt.pdf",
"type": "receipt"
}
],
"created_at": "2026-01-15T09:30:00Z",
"custom_fields": {
"Colour": "Blue",
"Voltage": 18
},
"description": "18 V drill with two batteries",
"id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"insured": true,
"lifetime_warranty": false,
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"location": "Red toolbox",
"location_id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"manufacturer": "Bosch",
"model_number": "GSR 18V-55",
"name": "Cordless drill",
"notes": "Two batteries",
"previous_quantity": 1,
"purchase_date": "2026-01-15",
"purchase_from": "Hardware Store",
"purchase_price": 129.99,
"quantity": 3,
"serial_number": "BSH-0042",
"sold_date": "",
"sold_notes": "",
"sold_price": 0,
"sold_to": "",
"tag_ids": [
"823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9"
],
"tags": [
"Tools"
],
"total_value": 389.97,
"updated_at": "2026-02-01T18:05:00Z",
"warranty_details": "2 years, register online",
"warranty_expires": "2028-01-15"
}Create item
Add an item to the inventory, with where it's kept, its tags and quantity, and its purchase, warranty and serial number if you have them.
Inputs
- Name
nametextRequired - What the item is called, such as Cordless drill.
- Description
descriptiontext - A short description, up to 1,000 characters.
- Location
locationtext - Where it's kept: pick a location, or give its ID, its name or its path, such as Garage / Tool shelf.
- Tags
tagslist - Tags to put on it, such as Electronics.
- Quantity
quantitynumber - How many there are. Leave blank for 1.From 0 to 1000000.
- Manufacturer
manufacturertext - Who made it, such as Bosch.
- Model number
model_numbertext - Its model number.
- Serial number
serial_numbertext - Its serial number.
- Purchase date
purchase_datedate - The day it was bought.
- Purchase price
purchase_pricenumber - What one cost, in the collection's currency, such as 129.99.From 0 to 1000000000.
- Purchased from
purchase_fromtext - Where it was bought.
- Warranty expires
warranty_expiresdate - The day its warranty ends.
- Warranty details
warranty_detailstext - Notes about the warranty, such as how to claim.
- Lifetime warranty
lifetime_warrantytrue/false - Whether its warranty never runs out.Default:
false. - Insured
insuredtrue/false - Whether it's covered by insurance.Default:
false. - Notes
notestext - Anything else worth keeping.
- Custom fields
custom_fieldsobject - Custom fields by name, such as Colour: Blue. A new field is a number, yes/no or text by its value.
Outputs
archivedtrue/false- Whether it's archived
asset_idtext- Its asset ID, such as 000-012 (blank when it has none)
attachmentslist- Its files and photos
created_attext- When it was added
custom_fieldsobject- Its custom fields, by name
descriptiontext- Its description
idtext- The item's ID, which other Homebox steps take
insuredtrue/false- Whether it's marked as insured
lifetime_warrantytrue/false- Whether it has a lifetime warranty
linktext- Where the item opens in Homebox
locationtext- The location it's in, such as Garage (blank when none)
location_idtext- That location's ID
manufacturertext- Who made it
model_numbertext- Its model number
nametext- The item's name
notestext- Notes kept on it
purchase_datetext- When it was bought (YYYY-MM-DD), blank when not set
purchase_fromtext- Where it was bought
purchase_pricenumber- What one cost
quantitynumber- How many there are
serial_numbertext- Its serial number
sold_datetext- When it was sold (YYYY-MM-DD), blank when it wasn't
sold_notestext- Notes about the sale
sold_pricenumber- What it sold for
sold_totext- Who it was sold to
tag_idslist- The IDs of its tags
tagslist- The names of its tags
total_valuenumber- The purchase price times the quantity
updated_attext- When it was last changed
warranty_detailstext- Notes about the warranty
warranty_expirestext- When its warranty runs out (YYYY-MM-DD), blank when not set
Example output
{
"archived": false,
"asset_id": "000-012",
"attachments": [
{
"content_type": "application/pdf",
"created_at": "2026-01-15T09:31:00Z",
"id": "39c9a96c-ab99-4c65-ac96-9f4c643d78d4",
"primary": false,
"title": "receipt.pdf",
"type": "receipt"
}
],
"created_at": "2026-01-15T09:30:00Z",
"custom_fields": {
"Colour": "Blue",
"Voltage": 18
},
"description": "18 V drill with two batteries",
"id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"insured": true,
"lifetime_warranty": false,
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"location": "Red toolbox",
"location_id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"manufacturer": "Bosch",
"model_number": "GSR 18V-55",
"name": "Cordless drill",
"notes": "Two batteries",
"purchase_date": "2026-01-15",
"purchase_from": "Hardware Store",
"purchase_price": 129.99,
"quantity": 1,
"serial_number": "BSH-0042",
"sold_date": "",
"sold_notes": "",
"sold_price": 0,
"sold_to": "",
"tag_ids": [
"823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9"
],
"tags": [
"Tools"
],
"total_value": 129.99,
"updated_at": "2026-02-01T18:05:00Z",
"warranty_details": "2 years, register online",
"warranty_expires": "2028-01-15"
}Create location
Add a location, such as a room, a shelf or a box, at the top or inside another location.
Inputs
- Name
nametextRequired - What the location is called, such as Tool shelf.
- Description
descriptiontext - A short description.
- Inside
parenttext - The location it's inside, such as Garage. Leave blank for the top.
Outputs
created_attext- When it was added
descriptiontext- Its description
idtext- The location's ID, which other Homebox steps take
linktext- Where the location opens in Homebox
nametext- The location's name
parenttext- The name of the location it's inside
parent_idtext- The ID of the location it's inside (blank at the top)
pathtext- Where it is, from the top: Garage / Tool shelf / Red toolbox
updated_attext- When it was last changed
Example output
{
"created_at": "2026-01-10T08:00:00Z",
"description": "On the bottom shelf",
"id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"link": "https://homebox.example.com/location/720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"name": "Red toolbox",
"parent": "Tool shelf",
"parent_id": "429a07ea-8b04-441e-a4b5-b691e3c6e4bc",
"path": "Garage / Tool shelf / Red toolbox",
"updated_at": "2026-01-10T08:00:00Z"
}Create tag
Add a tag to sort items by, such as Electronics, with a colour and inside another tag if you like.
Inputs
- Name
nametextRequired - What the tag is called, such as Tools.
- Description
descriptiontext - A short description.
- Colour
colortext - A colour code for it, such as #3b82f6.
- Inside
parenttext - The tag it's inside, such as Tools for Power tools. Leave blank for none.
Outputs
colortext- Its colour, such as #3b82f6 (blank when none)
descriptiontext- Its description
idtext- The tag's ID, which other Homebox steps take
linktext- Where the tag opens in Homebox
nametext- The tag's name
parenttext- The name of the tag it's inside
parent_idtext- The ID of the tag it's inside (blank when none)
Example output
{
"color": "#ef4444",
"description": "Hand and power tools",
"id": "823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9",
"link": "https://homebox.example.com/tag/823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9",
"name": "Tools",
"parent": "",
"parent_id": ""
}Delete attachment
Remove a file or photo from an item.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
- Attachment
attachmenttextRequired - The attachment's ID, from 'List attachments' or 'Upload attachment', or its title as Homebox shows it, such as receipt.pdf.
Outputs
deletedtrue/false- Whether it was removed
idtext- The attachment's ID
item_idtext- The ID of the item it was on
nametext- Its title
Example output
{
"deleted": true,
"id": "39c9a96c-ab99-4c65-ac96-9f4c643d78d4",
"item_id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"name": "receipt.pdf"
}Delete item
Delete an item for good, with its attachments and maintenance log. To keep its record, archive it with 'Update item' instead.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
Outputs
deletedtrue/false- Whether it was deleted
idtext- The ID of what was deleted
nametext- Its name
Example output
{
"deleted": true,
"id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"name": "Cordless drill"
}Delete location
Delete a location. What was in it stays in Homebox: its items are left without a location and the locations inside it move to the top.
Inputs
- Location
locationtextRequired - The location: pick one, or give its ID, its name or its path, such as Garage / Tool shelf.
Outputs
deletedtrue/false- Whether it was deleted
idtext- The ID of what was deleted
nametext- Its name
Example output
{
"deleted": true,
"id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"name": "Red toolbox"
}Delete maintenance entry
Delete an entry from an item's maintenance log.
Inputs
- Maintenance entry
entrytextRequired - The entry's ID, from another Homebox step such as 'List scheduled maintenance'.
Outputs
deletedtrue/false- Whether it was deleted
idtext- The ID of what was deleted
nametext- Its name
Example output
{
"deleted": true,
"id": "016b4bbb-d482-4e99-9eee-5f01d30d73b4",
"name": "Replace water filter"
}Delete tag
Delete a tag. The items that carried it stay, without it.
Inputs
- Tag
tagtextRequired - The tag: pick one, or give its ID or its name, such as Electronics.
Outputs
deletedtrue/false- Whether it was deleted
idtext- The ID of what was deleted
nametext- Its name
Example output
{
"deleted": true,
"id": "823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9",
"name": "Tools"
}Download attachment
Get one of an item's attachments as a file a later step can use, such as a receipt to email.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
- Attachment
attachmenttextRequired - The attachment's ID, from 'List attachments' or 'Upload attachment', or its title as Homebox shows it, such as receipt.pdf.
Outputs
attachment_idtext- The attachment's ID
content_typetext- The file's type, such as application/pdf
document_reftext- The saved file, which a later step can use
filenametext- The file's name
item_idtext- The ID of the item it's attached to
size_bytesnumber- The file's size in bytes
titletext- The attachment's title in Homebox
typetext- What it is: attachment, photo, manual, warranty or receipt
urltext- Where the saved file opens in Lodol
Example output
{
"attachment_id": "39c9a96c-ab99-4c65-ac96-9f4c643d78d4",
"content_type": "application/pdf",
"document_ref": "doc_0123456789abcdef01234567",
"filename": "receipt.pdf",
"item_id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"size_bytes": 48213,
"title": "receipt.pdf",
"type": "receipt",
"url": "/actions/core/serve-document/doc_0123456789abcdef01234567"
}Duplicate item
Make a copy of an item in the same location with the same tags and details, such as for a second one bought.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
- Name prefix
name_prefixtext - What to put before the copy's name. Defaults to 'Copy of '.
- Copy custom fields
copy_custom_fieldstrue/false - Copy the item's custom fields to the copy.Default:
true. - Copy attachments
copy_attachmentstrue/false - Copy the item's files and photos to the copy.Default:
false. - Copy maintenance log
copy_maintenancetrue/false - Copy the item's maintenance entries to the copy.Default:
false.
Outputs
archivedtrue/false- Whether it's archived
asset_idtext- Its asset ID, such as 000-012 (blank when it has none)
attachmentslist- Its files and photos
copied_from_idtext- The ID of the item it's a copy of
created_attext- When it was added
custom_fieldsobject- Its custom fields, by name
descriptiontext- Its description
idtext- The item's ID, which other Homebox steps take
insuredtrue/false- Whether it's marked as insured
lifetime_warrantytrue/false- Whether it has a lifetime warranty
linktext- Where the item opens in Homebox
locationtext- The location it's in, such as Garage (blank when none)
location_idtext- That location's ID
manufacturertext- Who made it
model_numbertext- Its model number
nametext- The item's name
notestext- Notes kept on it
purchase_datetext- When it was bought (YYYY-MM-DD), blank when not set
purchase_fromtext- Where it was bought
purchase_pricenumber- What one cost
quantitynumber- How many there are
serial_numbertext- Its serial number
sold_datetext- When it was sold (YYYY-MM-DD), blank when it wasn't
sold_notestext- Notes about the sale
sold_pricenumber- What it sold for
sold_totext- Who it was sold to
tag_idslist- The IDs of its tags
tagslist- The names of its tags
total_valuenumber- The purchase price times the quantity
updated_attext- When it was last changed
warranty_detailstext- Notes about the warranty
warranty_expirestext- When its warranty runs out (YYYY-MM-DD), blank when not set
Example output
{
"archived": false,
"asset_id": "000-013",
"attachments": [],
"copied_from_id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"created_at": "2026-01-15T09:30:00Z",
"custom_fields": {
"Colour": "Blue",
"Voltage": 18
},
"description": "18 V drill with two batteries",
"id": "8554517a-4622-4970-8db1-c2500814b22e",
"insured": true,
"lifetime_warranty": false,
"link": "https://homebox.example.com/item/8554517a-4622-4970-8db1-c2500814b22e",
"location": "Red toolbox",
"location_id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"manufacturer": "Bosch",
"model_number": "GSR 18V-55",
"name": "Copy of Cordless drill",
"notes": "Two batteries",
"purchase_date": "2026-01-15",
"purchase_from": "Hardware Store",
"purchase_price": 129.99,
"quantity": 1,
"serial_number": "BSH-0042",
"sold_date": "",
"sold_notes": "",
"sold_price": 0,
"sold_to": "",
"tag_ids": [
"823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9"
],
"tags": [
"Tools"
],
"total_value": 129.99,
"updated_at": "2026-02-01T18:05:00Z",
"warranty_details": "2 years, register online",
"warranty_expires": "2028-01-15"
}Export items as CSV
Get everything in the collection as CSV in Homebox's own format, as text and as rows, such as for a backup or an insurance list.
Inputs
None.
Outputs
countnumber- How many rows there are
csvtext- The export as CSV text, in Homebox's own format
file_nametext- A name to save the CSV under
rowslist- Each row of the export: an item or a location, with its id, is_location and the export's columns (name, location, quantity, purchase_price, warranty_expires and the rest)
Example output
{
"count": 1,
"csv": "HB.purchase_date,HB.warranty_expires,HB.url,HB.name,HB.location,HB.quantity,HB.purchase_price\n2026-01-15,2028-01-15,/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27,Cordless drill,Garage / Tool shelf / Red toolbox,1,129.99\n",
"file_name": "homebox-2026-11-17.csv",
"rows": [
{
"id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"is_location": false,
"location": "Garage / Tool shelf / Red toolbox",
"name": "Cordless drill",
"purchase_date": "2026-01-15",
"purchase_price": "129.99",
"quantity": "1",
"url": "/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"warranty_expires": "2028-01-15"
}
]
}Find expiring warranties
List the items whose warranty runs out within the days you choose, soonest first, with a summary ready for a message.
Inputs
- Days ahead
daysnumber - How many days ahead to look. Defaults to 30.From 0 to 3650.
- Include expired
include_expiredtrue/false - Also list items whose warranty has already run out.Default:
false.
Outputs
countnumber- How many there are
daysnumber- How many days ahead were looked at
itemslist- The items, soonest to run out first
texttext- The list as text, one item per line, to send to someone
Example output
{
"count": 1,
"days": 30,
"items": [
{
"asset_id": "000-012",
"days_left": 25,
"id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"location": "Garage / Tool shelf / Red toolbox",
"manufacturer": "Bosch",
"model_number": "GSR 18V-55",
"name": "Cordless drill",
"purchase_date": "2026-01-15",
"purchase_price": 129.99,
"serial_number": "BSH-0042",
"warranty_details": "2 years, register online",
"warranty_expires": "2028-01-15"
}
],
"text": "- Cordless drill: expires in 25 days (2028-01-15)"
}Find items
Search the inventory by words (names, descriptions, serial and model numbers, notes, tags and custom fields), by location and by tags.
Inputs
- Search for
querytext - Words to look for, such as drill or a serial number. Leave blank for every item.
- Location
locationtext - Only items here or in a location inside it, such as Garage.
- Tags
tagslist - Only items with one of these tags.
- Must have every tag
match_all_tagstrue/false - Only items that have all of the tags chosen, rather than any.Default:
false. - Archived items
archivedtext - Whether to return archived items. Defaults to those not archived.One of:
active(Not archived),archived(Archived only),all. Default:active. - Order by
order_bytext - How to order the items. Defaults to their names.One of:
name(Name (A to Z)),created(Newest first),updated(Last changed first),asset_id(Asset ID). Default:name. - Limit
limitnumber - The most items to return, up to 500. Defaults to 50.From 1 to 500.
- Page
pagenumber - Which page of results to return. Defaults to the first.From 1 to 100000.
Outputs
countnumber- How many items are on this page
has_moretrue/false- Whether there are more pages
itemslist- The items found
pagenumber- Which page this is
texttext- The items as text, one per line, to send to someone
totalnumber- How many items match in all
Example output
{
"count": 1,
"has_more": false,
"items": [
{
"archived": false,
"asset_id": "000-012",
"created_at": "2026-01-15T09:30:00Z",
"description": "18 V drill with two batteries",
"id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"insured": true,
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"location": "Red toolbox",
"location_id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"name": "Cordless drill",
"purchase_price": 129.99,
"quantity": 1,
"tag_ids": [
"823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9"
],
"tags": [
"Tools"
],
"total_value": 129.99,
"updated_at": "2026-02-01T18:05:00Z"
}
],
"page": 1,
"text": "- Cordless drill, Red toolbox, asset 000-012",
"total": 1
}Get item
Get an item with everything Homebox keeps about it: where it is, its purchase and warranty, serial number, custom fields and attachments.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
Outputs
archivedtrue/false- Whether it's archived
asset_idtext- Its asset ID, such as 000-012 (blank when it has none)
attachmentslist- Its files and photos
created_attext- When it was added
custom_fieldsobject- Its custom fields, by name
descriptiontext- Its description
idtext- The item's ID, which other Homebox steps take
insuredtrue/false- Whether it's marked as insured
lifetime_warrantytrue/false- Whether it has a lifetime warranty
linktext- Where the item opens in Homebox
locationtext- The location it's in, such as Garage (blank when none)
location_idtext- That location's ID
manufacturertext- Who made it
model_numbertext- Its model number
nametext- The item's name
notestext- Notes kept on it
purchase_datetext- When it was bought (YYYY-MM-DD), blank when not set
purchase_fromtext- Where it was bought
purchase_pricenumber- What one cost
quantitynumber- How many there are
serial_numbertext- Its serial number
sold_datetext- When it was sold (YYYY-MM-DD), blank when it wasn't
sold_notestext- Notes about the sale
sold_pricenumber- What it sold for
sold_totext- Who it was sold to
tag_idslist- The IDs of its tags
tagslist- The names of its tags
total_valuenumber- The purchase price times the quantity
updated_attext- When it was last changed
warranty_detailstext- Notes about the warranty
warranty_expirestext- When its warranty runs out (YYYY-MM-DD), blank when not set
Example output
{
"archived": false,
"asset_id": "000-012",
"attachments": [
{
"content_type": "application/pdf",
"created_at": "2026-01-15T09:31:00Z",
"id": "39c9a96c-ab99-4c65-ac96-9f4c643d78d4",
"primary": false,
"title": "receipt.pdf",
"type": "receipt"
}
],
"created_at": "2026-01-15T09:30:00Z",
"custom_fields": {
"Colour": "Blue",
"Voltage": 18
},
"description": "18 V drill with two batteries",
"id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"insured": true,
"lifetime_warranty": false,
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"location": "Red toolbox",
"location_id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"manufacturer": "Bosch",
"model_number": "GSR 18V-55",
"name": "Cordless drill",
"notes": "Two batteries",
"purchase_date": "2026-01-15",
"purchase_from": "Hardware Store",
"purchase_price": 129.99,
"quantity": 1,
"serial_number": "BSH-0042",
"sold_date": "",
"sold_notes": "",
"sold_price": 0,
"sold_to": "",
"tag_ids": [
"823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9"
],
"tags": [
"Tools"
],
"total_value": 129.99,
"updated_at": "2026-02-01T18:05:00Z",
"warranty_details": "2 years, register online",
"warranty_expires": "2028-01-15"
}Get item by asset ID
Look up the item with an asset ID, such as one read from its label. Says so when no item has it.
Inputs
- Asset ID
asset_idtextRequired - The asset ID, such as 000-012 or 12.
Outputs
archivedtrue/false- Whether it's archived
asset_idtext- Its asset ID, such as 000-012 (blank when it has none)
attachmentslist- Its files and photos
created_attext- When it was added
custom_fieldsobject- Its custom fields, by name
descriptiontext- Its description
foundtrue/false- Whether an item has the asset ID; the rest is blank when not
idtext- The item's ID, which other Homebox steps take
insuredtrue/false- Whether it's marked as insured
lifetime_warrantytrue/false- Whether it has a lifetime warranty
linktext- Where the item opens in Homebox
locationtext- The location it's in, such as Garage (blank when none)
location_idtext- That location's ID
manufacturertext- Who made it
model_numbertext- Its model number
nametext- The item's name
notestext- Notes kept on it
purchase_datetext- When it was bought (YYYY-MM-DD), blank when not set
purchase_fromtext- Where it was bought
purchase_pricenumber- What one cost
quantitynumber- How many there are
serial_numbertext- Its serial number
sold_datetext- When it was sold (YYYY-MM-DD), blank when it wasn't
sold_notestext- Notes about the sale
sold_pricenumber- What it sold for
sold_totext- Who it was sold to
tag_idslist- The IDs of its tags
tagslist- The names of its tags
total_valuenumber- The purchase price times the quantity
updated_attext- When it was last changed
warranty_detailstext- Notes about the warranty
warranty_expirestext- When its warranty runs out (YYYY-MM-DD), blank when not set
Example output
{
"archived": false,
"asset_id": "000-012",
"attachments": [
{
"content_type": "application/pdf",
"created_at": "2026-01-15T09:31:00Z",
"id": "39c9a96c-ab99-4c65-ac96-9f4c643d78d4",
"primary": false,
"title": "receipt.pdf",
"type": "receipt"
}
],
"created_at": "2026-01-15T09:30:00Z",
"custom_fields": {
"Colour": "Blue",
"Voltage": 18
},
"description": "18 V drill with two batteries",
"found": true,
"id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"insured": true,
"lifetime_warranty": false,
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"location": "Red toolbox",
"location_id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"manufacturer": "Bosch",
"model_number": "GSR 18V-55",
"name": "Cordless drill",
"notes": "Two batteries",
"purchase_date": "2026-01-15",
"purchase_from": "Hardware Store",
"purchase_price": 129.99,
"quantity": 1,
"serial_number": "BSH-0042",
"sold_date": "",
"sold_notes": "",
"sold_price": 0,
"sold_to": "",
"tag_ids": [
"823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9"
],
"tags": [
"Tools"
],
"total_value": 129.99,
"updated_at": "2026-02-01T18:05:00Z",
"warranty_details": "2 years, register online",
"warranty_expires": "2028-01-15"
}Get location
Get a location with the locations and items directly in it and what those items cost.
Inputs
- Location
locationtextRequired - The location: pick one, or give its ID, its name or its path, such as Garage / Tool shelf.
Outputs
created_attext- When it was added
descriptiontext- Its description
idtext- The location's ID, which other Homebox steps take
item_countnumber- How many items are directly in it
itemslist- The items directly in it
linktext- Where the location opens in Homebox
locationslist- The locations directly inside it
nametext- The location's name
parenttext- The name of the location it's inside
parent_idtext- The ID of the location it's inside (blank at the top)
pathtext- Where it is, from the top: Garage / Tool shelf / Red toolbox
total_valuenumber- What those items cost, counting each one's quantity
updated_attext- When it was last changed
Example output
{
"created_at": "2026-01-10T08:00:00Z",
"description": "On the bottom shelf",
"id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"item_count": 1,
"items": [
{
"archived": false,
"asset_id": "000-012",
"created_at": "2026-01-15T09:30:00Z",
"description": "18 V drill with two batteries",
"id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"insured": true,
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"location": "Red toolbox",
"location_id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"name": "Cordless drill",
"purchase_price": 129.99,
"quantity": 1,
"tag_ids": [
"823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9"
],
"tags": [
"Tools"
],
"total_value": 129.99,
"updated_at": "2026-02-01T18:05:00Z"
}
],
"link": "https://homebox.example.com/location/720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"locations": [],
"name": "Red toolbox",
"parent": "Tool shelf",
"parent_id": "429a07ea-8b04-441e-a4b5-b691e3c6e4bc",
"path": "Garage / Tool shelf / Red toolbox",
"total_value": 129.99,
"updated_at": "2026-01-10T08:00:00Z"
}Get statistics
Get the collection's totals (items, locations, tags, what it all cost, items under warranty) and its value by location and by tag.
Inputs
None.
Outputs
collectiontext- The collection's name
currencytext- The currency prices are in, such as USD
items_with_warrantynumber- How many items have a warranty
texttext- The totals in one line, to send to someone
total_itemsnumber- How many items there are
total_locationsnumber- How many locations there are
total_tagsnumber- How many tags there are
total_usersnumber- How many people share the collection
total_valuenumber- What everything cost, counting each item's quantity
value_by_locationlist- Each location with items directly in it, highest value first
value_by_taglist- Each tag on an item, highest value first
Example output
{
"collection": "Our home",
"currency": "USD",
"items_with_warranty": 4,
"text": "7 items in 9 locations, worth 3,775.49 USD",
"total_items": 7,
"total_locations": 9,
"total_tags": 6,
"total_users": 2,
"total_value": 3775.49,
"value_by_location": [
{
"id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"name": "Red toolbox",
"value": 129.99
}
],
"value_by_tag": [
{
"id": "823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9",
"name": "Tools",
"value": 204.99
}
]
}Get tag
Get a tag with the tags inside it and how many items carry it.
Inputs
- Tag
tagtextRequired - The tag: pick one, or give its ID or its name, such as Electronics.
Outputs
childrenlist- The tags inside it
colortext- Its colour, such as #3b82f6 (blank when none)
descriptiontext- Its description
idtext- The tag's ID, which other Homebox steps take
item_countnumber- How many items carry it
linktext- Where the tag opens in Homebox
nametext- The tag's name
parenttext- The name of the tag it's inside
parent_idtext- The ID of the tag it's inside (blank when none)
Example output
{
"children": [
{
"id": "b6e95222-eba3-4a29-b4c7-c2402883d7ac",
"name": "Power tools"
}
],
"color": "#ef4444",
"description": "Hand and power tools",
"id": "823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9",
"item_count": 3,
"link": "https://homebox.example.com/tag/823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9",
"name": "Tools",
"parent": "",
"parent_id": ""
}Import items from CSV
Add items from CSV in Homebox's own format (a header row with HB.name, and columns such as HB.location, HB.quantity and HB.tags). Locations and tags it names that don't exist are made.
Inputs
- CSV
csv_texttextRequired - The CSV, starting with its header row, such as HB.name,HB.location,HB.quantity.
Outputs
importedtrue/false- Whether Homebox took the CSV
linktext- Where the items are listed in Homebox
rowsnumber- How many rows were sent
Example output
{
"imported": true,
"link": "https://homebox.example.com/search",
"rows": 2
}List attachments
List the files and photos attached to an item.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
Outputs
attachmentslist- The item's files and photos
countnumber- How many there are
item_idtext- The item's ID
item_nametext- The item's name
linktext- Where the item opens in Homebox
Example output
{
"attachments": [
{
"content_type": "application/pdf",
"created_at": "2026-01-15T09:31:00Z",
"id": "39c9a96c-ab99-4c65-ac96-9f4c643d78d4",
"primary": false,
"title": "receipt.pdf",
"type": "receipt"
}
],
"count": 1,
"item_id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"item_name": "Cordless drill",
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27"
}List item maintenance
Get an item's maintenance log: what's scheduled, what was done and what it cost.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
- Show
statustext - Which entries to return. Defaults to both.One of:
scheduled(Scheduled (not done yet)),completed,both. Default:both.
Outputs
countnumber- How many entries there are
entrieslist- The entries, earliest date first
item_idtext- The item's ID
item_nametext- The item's name
texttext- The entries as text, one per line, to send to someone
total_costnumber- What they cost together
Example output
{
"count": 1,
"entries": [
{
"completed_date": "",
"cost": 39.9,
"days_until_due": 12,
"description": "Use the genuine filter",
"id": "016b4bbb-d482-4e99-9eee-5f01d30d73b4",
"item_id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"item_name": "Fridge",
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27/maintenance",
"name": "Replace water filter",
"scheduled_date": "2026-12-01",
"status": "scheduled"
}
],
"item_id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"item_name": "Fridge",
"text": "- Fridge: Replace water filter (due 2026-12-01, cost 39.9)",
"total_cost": 39.9
}List locations
List every location, each with its path such as Garage / Tool shelf, and as an indented tree.
Inputs
- Search for
querytext - Only locations whose path has these words. Leave blank for all.
Outputs
countnumber- How many locations there are
locationslist- Every location, each followed by those inside it
texttext- The locations as an indented tree
Example output
{
"count": 1,
"locations": [
{
"depth": 1,
"description": "Metal shelf by the door",
"id": "429a07ea-8b04-441e-a4b5-b691e3c6e4bc",
"link": "https://homebox.example.com/location/429a07ea-8b04-441e-a4b5-b691e3c6e4bc",
"name": "Tool shelf",
"parent": "Garage",
"parent_id": "a4de9eea-bd8e-456e-b576-2712575aa9dd",
"path": "Garage / Tool shelf"
}
],
"text": " - Tool shelf"
}List scheduled maintenance
List maintenance across every item: what's scheduled and not done yet (optionally only what's due soon), what was done, or both.
Inputs
- Show
statustext - Which entries to return. Defaults to scheduled.One of:
scheduled(Scheduled (not done yet)),completed,both. Default:scheduled. - Due within days
due_within_daysnumber - Only scheduled entries due within this many days, 0 for today and overdue. Leave blank for all.From 0 to 3650.
Outputs
countnumber- How many entries there are
entrieslist- The entries, earliest date first
texttext- The entries as text, one per line, to send to someone
total_costnumber- What they cost together
Example output
{
"count": 1,
"entries": [
{
"completed_date": "",
"cost": 39.9,
"days_until_due": 12,
"description": "Use the genuine filter",
"id": "016b4bbb-d482-4e99-9eee-5f01d30d73b4",
"item_id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"item_name": "Fridge",
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27/maintenance",
"name": "Replace water filter",
"scheduled_date": "2026-12-01",
"status": "scheduled"
}
],
"text": "- Fridge: Replace water filter (due 2026-12-01, cost 39.9)",
"total_cost": 39.9
}List tags
List every tag (called labels in older versions of Homebox).
Inputs
None.
Outputs
countnumber- How many tags there are
tagslist- Every tag, A to Z
texttext- The tags' names, with commas between
Example output
{
"count": 1,
"tags": [
{
"color": "#ef4444",
"description": "Hand and power tools",
"id": "823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9",
"link": "https://homebox.example.com/tag/823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9",
"name": "Tools",
"parent": "",
"parent_id": ""
}
],
"text": "Tools"
}Update item
Change an item: move it, retag it, record its purchase, warranty or sale, set custom fields, or archive it. Fields left blank stay as they are.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
- Name
nametext - What the item is called, such as Cordless drill.
- Description
descriptiontext - A short description, up to 1,000 characters.
- Location
locationtext - Where to move it: pick a location, or give its ID, name or path.
- Tags
tagslist - The tags it should have, replacing the ones it has. Leave empty to keep them.
- Quantity
quantitynumber - How many there are.From 0 to 1000000.
- Manufacturer
manufacturertext - Who made it, such as Bosch.
- Model number
model_numbertext - Its model number.
- Serial number
serial_numbertext - Its serial number.
- Purchase date
purchase_datedate - The day it was bought.
- Purchase price
purchase_pricenumber - What one cost, in the collection's currency, such as 129.99.From 0 to 1000000000.
- Purchased from
purchase_fromtext - Where it was bought.
- Warranty expires
warranty_expiresdate - The day its warranty ends.
- Warranty details
warranty_detailstext - Notes about the warranty, such as how to claim.
- Lifetime warranty
lifetime_warrantytext - Whether its warranty never runs out.One of:
keep(Leave as it is),yes,no. Default:keep. - Insured
insuredtext - Whether it's covered by insurance.One of:
keep(Leave as it is),yes,no. Default:keep. - Notes
notestext - Anything else worth keeping.
- Custom fields
custom_fieldsobject - Custom fields by name, such as Colour: Blue. A new field is a number, yes/no or text by its value; one the item has keeps its type, and a blank value removes it.
- Archived
archivedtext - Whether it's archived: kept, but out of the lists.One of:
keep(Leave as it is),yes,no. Default:keep. - Sold date
sold_datedate - The day it was sold.
- Sold to
sold_totext - Who bought it.
- Sold price
sold_pricenumber - What it sold for.From 0 to 1000000000.
- Sale notes
sold_notestext - Notes about the sale.
Outputs
archivedtrue/false- Whether it's archived
asset_idtext- Its asset ID, such as 000-012 (blank when it has none)
attachmentslist- Its files and photos
created_attext- When it was added
custom_fieldsobject- Its custom fields, by name
descriptiontext- Its description
idtext- The item's ID, which other Homebox steps take
insuredtrue/false- Whether it's marked as insured
lifetime_warrantytrue/false- Whether it has a lifetime warranty
linktext- Where the item opens in Homebox
locationtext- The location it's in, such as Garage (blank when none)
location_idtext- That location's ID
manufacturertext- Who made it
model_numbertext- Its model number
nametext- The item's name
notestext- Notes kept on it
purchase_datetext- When it was bought (YYYY-MM-DD), blank when not set
purchase_fromtext- Where it was bought
purchase_pricenumber- What one cost
quantitynumber- How many there are
serial_numbertext- Its serial number
sold_datetext- When it was sold (YYYY-MM-DD), blank when it wasn't
sold_notestext- Notes about the sale
sold_pricenumber- What it sold for
sold_totext- Who it was sold to
tag_idslist- The IDs of its tags
tagslist- The names of its tags
total_valuenumber- The purchase price times the quantity
updated_attext- When it was last changed
warranty_detailstext- Notes about the warranty
warranty_expirestext- When its warranty runs out (YYYY-MM-DD), blank when not set
Example output
{
"archived": false,
"asset_id": "000-012",
"attachments": [
{
"content_type": "application/pdf",
"created_at": "2026-01-15T09:31:00Z",
"id": "39c9a96c-ab99-4c65-ac96-9f4c643d78d4",
"primary": false,
"title": "receipt.pdf",
"type": "receipt"
}
],
"created_at": "2026-01-15T09:30:00Z",
"custom_fields": {
"Colour": "Blue",
"Voltage": 18
},
"description": "18 V drill with two batteries",
"id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"insured": true,
"lifetime_warranty": false,
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"location": "Red toolbox",
"location_id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"manufacturer": "Bosch",
"model_number": "GSR 18V-55",
"name": "Cordless drill",
"notes": "Two batteries",
"purchase_date": "2026-01-15",
"purchase_from": "Hardware Store",
"purchase_price": 129.99,
"quantity": 1,
"serial_number": "BSH-0042",
"sold_date": "",
"sold_notes": "",
"sold_price": 0,
"sold_to": "",
"tag_ids": [
"823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9"
],
"tags": [
"Tools"
],
"total_value": 129.99,
"updated_at": "2026-02-01T18:05:00Z",
"warranty_details": "2 years, register online",
"warranty_expires": "2028-01-15"
}Update location
Rename or describe a location, or move it inside another. Fields left blank stay as they are.
Inputs
- Location
locationtextRequired - The location: pick one, or give its ID, its name or its path, such as Garage / Tool shelf.
- Name
nametext - A new name for the location.
- Description
descriptiontext - A new description.
- Move inside
parenttext - The location to move it into.
Outputs
created_attext- When it was added
descriptiontext- Its description
idtext- The location's ID, which other Homebox steps take
linktext- Where the location opens in Homebox
nametext- The location's name
parenttext- The name of the location it's inside
parent_idtext- The ID of the location it's inside (blank at the top)
pathtext- Where it is, from the top: Garage / Tool shelf / Red toolbox
updated_attext- When it was last changed
Example output
{
"created_at": "2026-01-10T08:00:00Z",
"description": "On the bottom shelf",
"id": "720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"link": "https://homebox.example.com/location/720a82ff-f4ef-46a2-9250-5d4ee6bc992d",
"name": "Red toolbox",
"parent": "Tool shelf",
"parent_id": "429a07ea-8b04-441e-a4b5-b691e3c6e4bc",
"path": "Garage / Tool shelf / Red toolbox",
"updated_at": "2026-01-10T08:00:00Z"
}Update maintenance entry
Change a maintenance entry, such as marking it done with the day and the cost, or moving it to another day. Fields left blank stay as they are.
Inputs
- Maintenance entry
entrytextRequired - The entry's ID, from another Homebox step such as 'List scheduled maintenance'.
- Name
nametext - A new name for the entry.
- Description
descriptiontext - New notes.
- Scheduled date
scheduled_datedate - A new day it's due.
- Completed date
completed_datedate - The day it was done, which marks it completed.
- Cost
costnumber - What it cost.From 0 to 1000000000.
Outputs
completed_datetext- When it was done (YYYY-MM-DD), blank when not done
costnumber- What it cost
days_until_duenumber- Days until it's due (negative when overdue); empty when done or not scheduled
descriptiontext- Notes about it
idtext- The entry's ID, which other Homebox steps take
item_idtext- The ID of the item it's for
item_nametext- The name of the item it's for
linktext- Where the item's maintenance log opens in Homebox
nametext- What the maintenance is
scheduled_datetext- When it's due (YYYY-MM-DD), blank when not scheduled
statustext- scheduled or completed
Example output
{
"completed_date": "2026-12-01",
"cost": 39.9,
"days_until_due": null,
"description": "Use the genuine filter",
"id": "016b4bbb-d482-4e99-9eee-5f01d30d73b4",
"item_id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"item_name": "Fridge",
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27/maintenance",
"name": "Replace water filter",
"scheduled_date": "2026-12-01",
"status": "completed"
}Update tag
Rename, describe or recolour a tag, or move it inside another. Fields left blank stay as they are.
Inputs
- Tag
tagtextRequired - The tag: pick one, or give its ID or its name, such as Electronics.
- Name
nametext - A new name for the tag.
- Description
descriptiontext - A new description.
- Colour
colortext - A new colour code, such as #3b82f6.
- Move inside
parenttext - The tag to move it into.
Outputs
colortext- Its colour, such as #3b82f6 (blank when none)
descriptiontext- Its description
idtext- The tag's ID, which other Homebox steps take
linktext- Where the tag opens in Homebox
nametext- The tag's name
parenttext- The name of the tag it's inside
parent_idtext- The ID of the tag it's inside (blank when none)
Example output
{
"color": "#ef4444",
"description": "Hand and power tools",
"id": "823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9",
"link": "https://homebox.example.com/tag/823879c8-a79f-4ae3-97e2-ef9ffdd8b6f9",
"name": "Tools",
"parent": "",
"parent_id": ""
}Upload attachment
Attach a file to an item, such as a photo, a receipt, a manual or a warranty card.
Inputs
- Item
itemtextRequired - The item: pick one, or give its ID from another Homebox step, a link to it in Homebox or its asset ID, such as 000-012.
- File
filetextRequired - The file: upload one, pick one from an earlier step, or give a public https link to download.
- File name
file_nametext - The name to give it, with its ending, such as receipt.pdf. Leave blank to use the file's own name.
- Type
attachment_typetext - What the file is. Defaults to Attachment.One of:
attachment,photo,manual,warranty,receipt. Default:attachment. - Main photo
primarytrue/false - Make this photo the one Homebox shows for the item.Default:
false.
Outputs
attachment_countnumber- How many attachments the item has now
content_typetext- The file's type, such as image/png
created_attext- When it was attached
idtext- The attachment's ID, which other Homebox steps take
item_idtext- The ID of the item it's attached to
item_nametext- That item's name
linktext- Where the item opens in Homebox
primarytrue/false- Whether it's the item's main photo
titletext- Its title, usually the file's name
typetext- What it is: attachment, photo, manual, warranty or receipt
Example output
{
"attachment_count": 2,
"content_type": "application/pdf",
"created_at": "2026-01-15T09:31:00Z",
"id": "39c9a96c-ab99-4c65-ac96-9f4c643d78d4",
"item_id": "f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"item_name": "Cordless drill",
"link": "https://homebox.example.com/item/f1a64023-4a8a-4b04-b10f-fd06a3bc1e27",
"primary": false,
"title": "receipt.pdf",
"type": "receipt"
}