# Homebox

> 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.

App · 31 actions. Web page: https://docs.lodol.com/docs/integrations/homebox

## Actions

### 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 (`item`, text, required): 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 (`name`, text, required): What the maintenance is, such as Replace water filter.
- Description (`description`, text): Notes about it.
- Scheduled date (`scheduled_date`, date): The day it's due. Give this, a completed date, or both.
- Completed date (`completed_date`, date): The day it was done.
- Cost (`cost`, number): What it cost. From 0 to 1000000000.

**Outputs**

- `completed_date` (text): When it was done (YYYY-MM-DD), blank when not done
- `cost` (number): What it cost
- `days_until_due` (number): Days until it's due (negative when overdue); empty when done or not scheduled
- `description` (text): Notes about it
- `id` (text): The entry's ID, which other Homebox steps take
- `item_id` (text): The ID of the item it's for
- `item_name` (text): The name of the item it's for
- `link` (text): Where the item's maintenance log opens in Homebox
- `name` (text): What the maintenance is
- `scheduled_date` (text): When it's due (YYYY-MM-DD), blank when not scheduled
- `status` (text): scheduled or completed

**Example output**

```json
{
  "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 (`item`, text, required): 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 (`quantity`, number): The new quantity. Leave blank to add or take away instead. From 0 to 1000000.
- Change by (`change_by`, number): How many to add, or to take away with a minus, such as -1. From -1000000 to 1000000.

**Outputs**

- `archived` (true/false): Whether it's archived
- `asset_id` (text): Its asset ID, such as 000-012 (blank when it has none)
- `attachments` (list): Its files and photos
- `created_at` (text): When it was added
- `custom_fields` (object): Its custom fields, by name
- `description` (text): Its description
- `id` (text): The item's ID, which other Homebox steps take
- `insured` (true/false): Whether it's marked as insured
- `lifetime_warranty` (true/false): Whether it has a lifetime warranty
- `link` (text): Where the item opens in Homebox
- `location` (text): The location it's in, such as Garage (blank when none)
- `location_id` (text): That location's ID
- `manufacturer` (text): Who made it
- `model_number` (text): Its model number
- `name` (text): The item's name
- `notes` (text): Notes kept on it
- `previous_quantity` (number): How many there were before the change
- `purchase_date` (text): When it was bought (YYYY-MM-DD), blank when not set
- `purchase_from` (text): Where it was bought
- `purchase_price` (number): What one cost
- `quantity` (number): How many there are
- `serial_number` (text): Its serial number
- `sold_date` (text): When it was sold (YYYY-MM-DD), blank when it wasn't
- `sold_notes` (text): Notes about the sale
- `sold_price` (number): What it sold for
- `sold_to` (text): Who it was sold to
- `tag_ids` (list): The IDs of its tags
- `tags` (list): The names of its tags
- `total_value` (number): The purchase price times the quantity
- `updated_at` (text): When it was last changed
- `warranty_details` (text): Notes about the warranty
- `warranty_expires` (text): When its warranty runs out (YYYY-MM-DD), blank when not set

**Example output**

```json
{
  "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 (`name`, text, required): What the item is called, such as Cordless drill.
- Description (`description`, text): A short description, up to 1,000 characters.
- Location (`location`, text): Where it's kept: pick a location, or give its ID, its name or its path, such as Garage / Tool shelf.
- Tags (`tags`, list): Tags to put on it, such as Electronics.
- Quantity (`quantity`, number): How many there are. Leave blank for 1. From 0 to 1000000.
- Manufacturer (`manufacturer`, text): Who made it, such as Bosch.
- Model number (`model_number`, text): Its model number.
- Serial number (`serial_number`, text): Its serial number.
- Purchase date (`purchase_date`, date): The day it was bought.
- Purchase price (`purchase_price`, number): What one cost, in the collection's currency, such as 129.99. From 0 to 1000000000.
- Purchased from (`purchase_from`, text): Where it was bought.
- Warranty expires (`warranty_expires`, date): The day its warranty ends.
- Warranty details (`warranty_details`, text): Notes about the warranty, such as how to claim.
- Lifetime warranty (`lifetime_warranty`, true/false): Whether its warranty never runs out. Default: `false`.
- Insured (`insured`, true/false): Whether it's covered by insurance. Default: `false`.
- Notes (`notes`, text): Anything else worth keeping.
- Custom fields (`custom_fields`, object): Custom fields by name, such as Colour: Blue. A new field is a number, yes/no or text by its value.

**Outputs**

- `archived` (true/false): Whether it's archived
- `asset_id` (text): Its asset ID, such as 000-012 (blank when it has none)
- `attachments` (list): Its files and photos
- `created_at` (text): When it was added
- `custom_fields` (object): Its custom fields, by name
- `description` (text): Its description
- `id` (text): The item's ID, which other Homebox steps take
- `insured` (true/false): Whether it's marked as insured
- `lifetime_warranty` (true/false): Whether it has a lifetime warranty
- `link` (text): Where the item opens in Homebox
- `location` (text): The location it's in, such as Garage (blank when none)
- `location_id` (text): That location's ID
- `manufacturer` (text): Who made it
- `model_number` (text): Its model number
- `name` (text): The item's name
- `notes` (text): Notes kept on it
- `purchase_date` (text): When it was bought (YYYY-MM-DD), blank when not set
- `purchase_from` (text): Where it was bought
- `purchase_price` (number): What one cost
- `quantity` (number): How many there are
- `serial_number` (text): Its serial number
- `sold_date` (text): When it was sold (YYYY-MM-DD), blank when it wasn't
- `sold_notes` (text): Notes about the sale
- `sold_price` (number): What it sold for
- `sold_to` (text): Who it was sold to
- `tag_ids` (list): The IDs of its tags
- `tags` (list): The names of its tags
- `total_value` (number): The purchase price times the quantity
- `updated_at` (text): When it was last changed
- `warranty_details` (text): Notes about the warranty
- `warranty_expires` (text): When its warranty runs out (YYYY-MM-DD), blank when not set

**Example output**

```json
{
  "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 (`name`, text, required): What the location is called, such as Tool shelf.
- Description (`description`, text): A short description.
- Inside (`parent`, text): The location it's inside, such as Garage. Leave blank for the top.

**Outputs**

- `created_at` (text): When it was added
- `description` (text): Its description
- `id` (text): The location's ID, which other Homebox steps take
- `link` (text): Where the location opens in Homebox
- `name` (text): The location's name
- `parent` (text): The name of the location it's inside
- `parent_id` (text): The ID of the location it's inside (blank at the top)
- `path` (text): Where it is, from the top: Garage / Tool shelf / Red toolbox
- `updated_at` (text): When it was last changed

**Example output**

```json
{
  "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 (`name`, text, required): What the tag is called, such as Tools.
- Description (`description`, text): A short description.
- Colour (`color`, text): A colour code for it, such as #3b82f6.
- Inside (`parent`, text): The tag it's inside, such as Tools for Power tools. Leave blank for none.

**Outputs**

- `color` (text): Its colour, such as #3b82f6 (blank when none)
- `description` (text): Its description
- `id` (text): The tag's ID, which other Homebox steps take
- `link` (text): Where the tag opens in Homebox
- `name` (text): The tag's name
- `parent` (text): The name of the tag it's inside
- `parent_id` (text): The ID of the tag it's inside (blank when none)

**Example output**

```json
{
  "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 (`item`, text, required): 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 (`attachment`, text, required): The attachment's ID, from 'List attachments' or 'Upload attachment', or its title as Homebox shows it, such as receipt.pdf.

**Outputs**

- `deleted` (true/false): Whether it was removed
- `id` (text): The attachment's ID
- `item_id` (text): The ID of the item it was on
- `name` (text): Its title

**Example output**

```json
{
  "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 (`item`, text, required): 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**

- `deleted` (true/false): Whether it was deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name

**Example output**

```json
{
  "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 (`location`, text, required): The location: pick one, or give its ID, its name or its path, such as Garage / Tool shelf.

**Outputs**

- `deleted` (true/false): Whether it was deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name

**Example output**

```json
{
  "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 (`entry`, text, required): The entry's ID, from another Homebox step such as 'List scheduled maintenance'.

**Outputs**

- `deleted` (true/false): Whether it was deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name

**Example output**

```json
{
  "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 (`tag`, text, required): The tag: pick one, or give its ID or its name, such as Electronics.

**Outputs**

- `deleted` (true/false): Whether it was deleted
- `id` (text): The ID of what was deleted
- `name` (text): Its name

**Example output**

```json
{
  "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 (`item`, text, required): 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 (`attachment`, text, required): The attachment's ID, from 'List attachments' or 'Upload attachment', or its title as Homebox shows it, such as receipt.pdf.

**Outputs**

- `attachment_id` (text): The attachment's ID
- `content_type` (text): The file's type, such as application/pdf
- `document_ref` (text): The saved file, which a later step can use
- `filename` (text): The file's name
- `item_id` (text): The ID of the item it's attached to
- `size_bytes` (number): The file's size in bytes
- `title` (text): The attachment's title in Homebox
- `type` (text): What it is: attachment, photo, manual, warranty or receipt
- `url` (text): Where the saved file opens in Lodol

**Example output**

```json
{
  "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 (`item`, text, required): 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_prefix`, text): What to put before the copy's name. Defaults to 'Copy of '.
- Copy custom fields (`copy_custom_fields`, true/false): Copy the item's custom fields to the copy. Default: `true`.
- Copy attachments (`copy_attachments`, true/false): Copy the item's files and photos to the copy. Default: `false`.
- Copy maintenance log (`copy_maintenance`, true/false): Copy the item's maintenance entries to the copy. Default: `false`.

**Outputs**

- `archived` (true/false): Whether it's archived
- `asset_id` (text): Its asset ID, such as 000-012 (blank when it has none)
- `attachments` (list): Its files and photos
- `copied_from_id` (text): The ID of the item it's a copy of
- `created_at` (text): When it was added
- `custom_fields` (object): Its custom fields, by name
- `description` (text): Its description
- `id` (text): The item's ID, which other Homebox steps take
- `insured` (true/false): Whether it's marked as insured
- `lifetime_warranty` (true/false): Whether it has a lifetime warranty
- `link` (text): Where the item opens in Homebox
- `location` (text): The location it's in, such as Garage (blank when none)
- `location_id` (text): That location's ID
- `manufacturer` (text): Who made it
- `model_number` (text): Its model number
- `name` (text): The item's name
- `notes` (text): Notes kept on it
- `purchase_date` (text): When it was bought (YYYY-MM-DD), blank when not set
- `purchase_from` (text): Where it was bought
- `purchase_price` (number): What one cost
- `quantity` (number): How many there are
- `serial_number` (text): Its serial number
- `sold_date` (text): When it was sold (YYYY-MM-DD), blank when it wasn't
- `sold_notes` (text): Notes about the sale
- `sold_price` (number): What it sold for
- `sold_to` (text): Who it was sold to
- `tag_ids` (list): The IDs of its tags
- `tags` (list): The names of its tags
- `total_value` (number): The purchase price times the quantity
- `updated_at` (text): When it was last changed
- `warranty_details` (text): Notes about the warranty
- `warranty_expires` (text): When its warranty runs out (YYYY-MM-DD), blank when not set

**Example output**

```json
{
  "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**

- `count` (number): How many rows there are
- `csv` (text): The export as CSV text, in Homebox's own format
- `file_name` (text): A name to save the CSV under
- `rows` (list): 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**

```json
{
  "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 (`days`, number): How many days ahead to look. Defaults to 30. From 0 to 3650.
- Include expired (`include_expired`, true/false): Also list items whose warranty has already run out. Default: `false`.

**Outputs**

- `count` (number): How many there are
- `days` (number): How many days ahead were looked at
- `items` (list): The items, soonest to run out first
- `text` (text): The list as text, one item per line, to send to someone

**Example output**

```json
{
  "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 (`query`, text): Words to look for, such as drill or a serial number. Leave blank for every item.
- Location (`location`, text): Only items here or in a location inside it, such as Garage.
- Tags (`tags`, list): Only items with one of these tags.
- Must have every tag (`match_all_tags`, true/false): Only items that have all of the tags chosen, rather than any. Default: `false`.
- Archived items (`archived`, text): Whether to return archived items. Defaults to those not archived. One of: `active` (Not archived), `archived` (Archived only), `all`. Default: `active`.
- Order by (`order_by`, text): 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 (`limit`, number): The most items to return, up to 500. Defaults to 50. From 1 to 500.
- Page (`page`, number): Which page of results to return. Defaults to the first. From 1 to 100000.

**Outputs**

- `count` (number): How many items are on this page
- `has_more` (true/false): Whether there are more pages
- `items` (list): The items found
- `page` (number): Which page this is
- `text` (text): The items as text, one per line, to send to someone
- `total` (number): How many items match in all

**Example output**

```json
{
  "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 (`item`, text, required): 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**

- `archived` (true/false): Whether it's archived
- `asset_id` (text): Its asset ID, such as 000-012 (blank when it has none)
- `attachments` (list): Its files and photos
- `created_at` (text): When it was added
- `custom_fields` (object): Its custom fields, by name
- `description` (text): Its description
- `id` (text): The item's ID, which other Homebox steps take
- `insured` (true/false): Whether it's marked as insured
- `lifetime_warranty` (true/false): Whether it has a lifetime warranty
- `link` (text): Where the item opens in Homebox
- `location` (text): The location it's in, such as Garage (blank when none)
- `location_id` (text): That location's ID
- `manufacturer` (text): Who made it
- `model_number` (text): Its model number
- `name` (text): The item's name
- `notes` (text): Notes kept on it
- `purchase_date` (text): When it was bought (YYYY-MM-DD), blank when not set
- `purchase_from` (text): Where it was bought
- `purchase_price` (number): What one cost
- `quantity` (number): How many there are
- `serial_number` (text): Its serial number
- `sold_date` (text): When it was sold (YYYY-MM-DD), blank when it wasn't
- `sold_notes` (text): Notes about the sale
- `sold_price` (number): What it sold for
- `sold_to` (text): Who it was sold to
- `tag_ids` (list): The IDs of its tags
- `tags` (list): The names of its tags
- `total_value` (number): The purchase price times the quantity
- `updated_at` (text): When it was last changed
- `warranty_details` (text): Notes about the warranty
- `warranty_expires` (text): When its warranty runs out (YYYY-MM-DD), blank when not set

**Example output**

```json
{
  "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_id`, text, required): The asset ID, such as 000-012 or 12.

**Outputs**

- `archived` (true/false): Whether it's archived
- `asset_id` (text): Its asset ID, such as 000-012 (blank when it has none)
- `attachments` (list): Its files and photos
- `created_at` (text): When it was added
- `custom_fields` (object): Its custom fields, by name
- `description` (text): Its description
- `found` (true/false): Whether an item has the asset ID; the rest is blank when not
- `id` (text): The item's ID, which other Homebox steps take
- `insured` (true/false): Whether it's marked as insured
- `lifetime_warranty` (true/false): Whether it has a lifetime warranty
- `link` (text): Where the item opens in Homebox
- `location` (text): The location it's in, such as Garage (blank when none)
- `location_id` (text): That location's ID
- `manufacturer` (text): Who made it
- `model_number` (text): Its model number
- `name` (text): The item's name
- `notes` (text): Notes kept on it
- `purchase_date` (text): When it was bought (YYYY-MM-DD), blank when not set
- `purchase_from` (text): Where it was bought
- `purchase_price` (number): What one cost
- `quantity` (number): How many there are
- `serial_number` (text): Its serial number
- `sold_date` (text): When it was sold (YYYY-MM-DD), blank when it wasn't
- `sold_notes` (text): Notes about the sale
- `sold_price` (number): What it sold for
- `sold_to` (text): Who it was sold to
- `tag_ids` (list): The IDs of its tags
- `tags` (list): The names of its tags
- `total_value` (number): The purchase price times the quantity
- `updated_at` (text): When it was last changed
- `warranty_details` (text): Notes about the warranty
- `warranty_expires` (text): When its warranty runs out (YYYY-MM-DD), blank when not set

**Example output**

```json
{
  "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 (`location`, text, required): The location: pick one, or give its ID, its name or its path, such as Garage / Tool shelf.

**Outputs**

- `created_at` (text): When it was added
- `description` (text): Its description
- `id` (text): The location's ID, which other Homebox steps take
- `item_count` (number): How many items are directly in it
- `items` (list): The items directly in it
- `link` (text): Where the location opens in Homebox
- `locations` (list): The locations directly inside it
- `name` (text): The location's name
- `parent` (text): The name of the location it's inside
- `parent_id` (text): The ID of the location it's inside (blank at the top)
- `path` (text): Where it is, from the top: Garage / Tool shelf / Red toolbox
- `total_value` (number): What those items cost, counting each one's quantity
- `updated_at` (text): When it was last changed

**Example output**

```json
{
  "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**

- `collection` (text): The collection's name
- `currency` (text): The currency prices are in, such as USD
- `items_with_warranty` (number): How many items have a warranty
- `text` (text): The totals in one line, to send to someone
- `total_items` (number): How many items there are
- `total_locations` (number): How many locations there are
- `total_tags` (number): How many tags there are
- `total_users` (number): How many people share the collection
- `total_value` (number): What everything cost, counting each item's quantity
- `value_by_location` (list): Each location with items directly in it, highest value first
- `value_by_tag` (list): Each tag on an item, highest value first

**Example output**

```json
{
  "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 (`tag`, text, required): The tag: pick one, or give its ID or its name, such as Electronics.

**Outputs**

- `children` (list): The tags inside it
- `color` (text): Its colour, such as #3b82f6 (blank when none)
- `description` (text): Its description
- `id` (text): The tag's ID, which other Homebox steps take
- `item_count` (number): How many items carry it
- `link` (text): Where the tag opens in Homebox
- `name` (text): The tag's name
- `parent` (text): The name of the tag it's inside
- `parent_id` (text): The ID of the tag it's inside (blank when none)

**Example output**

```json
{
  "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_text`, text, required): The CSV, starting with its header row, such as HB.name,HB.location,HB.quantity.

**Outputs**

- `imported` (true/false): Whether Homebox took the CSV
- `link` (text): Where the items are listed in Homebox
- `rows` (number): How many rows were sent

**Example output**

```json
{
  "imported": true,
  "link": "https://homebox.example.com/search",
  "rows": 2
}
```

### List attachments

List the files and photos attached to an item.

**Inputs**

- Item (`item`, text, required): 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**

- `attachments` (list): The item's files and photos
- `count` (number): How many there are
- `item_id` (text): The item's ID
- `item_name` (text): The item's name
- `link` (text): Where the item opens in Homebox

**Example output**

```json
{
  "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 (`item`, text, required): 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 (`status`, text): Which entries to return. Defaults to both. One of: `scheduled` (Scheduled (not done yet)), `completed`, `both`. Default: `both`.

**Outputs**

- `count` (number): How many entries there are
- `entries` (list): The entries, earliest date first
- `item_id` (text): The item's ID
- `item_name` (text): The item's name
- `text` (text): The entries as text, one per line, to send to someone
- `total_cost` (number): What they cost together

**Example output**

```json
{
  "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 (`query`, text): Only locations whose path has these words. Leave blank for all.

**Outputs**

- `count` (number): How many locations there are
- `locations` (list): Every location, each followed by those inside it
- `text` (text): The locations as an indented tree

**Example output**

```json
{
  "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 (`status`, text): Which entries to return. Defaults to scheduled. One of: `scheduled` (Scheduled (not done yet)), `completed`, `both`. Default: `scheduled`.
- Due within days (`due_within_days`, number): Only scheduled entries due within this many days, 0 for today and overdue. Leave blank for all. From 0 to 3650.

**Outputs**

- `count` (number): How many entries there are
- `entries` (list): The entries, earliest date first
- `text` (text): The entries as text, one per line, to send to someone
- `total_cost` (number): What they cost together

**Example output**

```json
{
  "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**

- `count` (number): How many tags there are
- `tags` (list): Every tag, A to Z
- `text` (text): The tags' names, with commas between

**Example output**

```json
{
  "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 (`item`, text, required): 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 (`name`, text): What the item is called, such as Cordless drill.
- Description (`description`, text): A short description, up to 1,000 characters.
- Location (`location`, text): Where to move it: pick a location, or give its ID, name or path.
- Tags (`tags`, list): The tags it should have, replacing the ones it has. Leave empty to keep them.
- Quantity (`quantity`, number): How many there are. From 0 to 1000000.
- Manufacturer (`manufacturer`, text): Who made it, such as Bosch.
- Model number (`model_number`, text): Its model number.
- Serial number (`serial_number`, text): Its serial number.
- Purchase date (`purchase_date`, date): The day it was bought.
- Purchase price (`purchase_price`, number): What one cost, in the collection's currency, such as 129.99. From 0 to 1000000000.
- Purchased from (`purchase_from`, text): Where it was bought.
- Warranty expires (`warranty_expires`, date): The day its warranty ends.
- Warranty details (`warranty_details`, text): Notes about the warranty, such as how to claim.
- Lifetime warranty (`lifetime_warranty`, text): Whether its warranty never runs out. One of: `keep` (Leave as it is), `yes`, `no`. Default: `keep`.
- Insured (`insured`, text): Whether it's covered by insurance. One of: `keep` (Leave as it is), `yes`, `no`. Default: `keep`.
- Notes (`notes`, text): Anything else worth keeping.
- Custom fields (`custom_fields`, object): 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 (`archived`, text): Whether it's archived: kept, but out of the lists. One of: `keep` (Leave as it is), `yes`, `no`. Default: `keep`.
- Sold date (`sold_date`, date): The day it was sold.
- Sold to (`sold_to`, text): Who bought it.
- Sold price (`sold_price`, number): What it sold for. From 0 to 1000000000.
- Sale notes (`sold_notes`, text): Notes about the sale.

**Outputs**

- `archived` (true/false): Whether it's archived
- `asset_id` (text): Its asset ID, such as 000-012 (blank when it has none)
- `attachments` (list): Its files and photos
- `created_at` (text): When it was added
- `custom_fields` (object): Its custom fields, by name
- `description` (text): Its description
- `id` (text): The item's ID, which other Homebox steps take
- `insured` (true/false): Whether it's marked as insured
- `lifetime_warranty` (true/false): Whether it has a lifetime warranty
- `link` (text): Where the item opens in Homebox
- `location` (text): The location it's in, such as Garage (blank when none)
- `location_id` (text): That location's ID
- `manufacturer` (text): Who made it
- `model_number` (text): Its model number
- `name` (text): The item's name
- `notes` (text): Notes kept on it
- `purchase_date` (text): When it was bought (YYYY-MM-DD), blank when not set
- `purchase_from` (text): Where it was bought
- `purchase_price` (number): What one cost
- `quantity` (number): How many there are
- `serial_number` (text): Its serial number
- `sold_date` (text): When it was sold (YYYY-MM-DD), blank when it wasn't
- `sold_notes` (text): Notes about the sale
- `sold_price` (number): What it sold for
- `sold_to` (text): Who it was sold to
- `tag_ids` (list): The IDs of its tags
- `tags` (list): The names of its tags
- `total_value` (number): The purchase price times the quantity
- `updated_at` (text): When it was last changed
- `warranty_details` (text): Notes about the warranty
- `warranty_expires` (text): When its warranty runs out (YYYY-MM-DD), blank when not set

**Example output**

```json
{
  "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 (`location`, text, required): The location: pick one, or give its ID, its name or its path, such as Garage / Tool shelf.
- Name (`name`, text): A new name for the location.
- Description (`description`, text): A new description.
- Move inside (`parent`, text): The location to move it into.

**Outputs**

- `created_at` (text): When it was added
- `description` (text): Its description
- `id` (text): The location's ID, which other Homebox steps take
- `link` (text): Where the location opens in Homebox
- `name` (text): The location's name
- `parent` (text): The name of the location it's inside
- `parent_id` (text): The ID of the location it's inside (blank at the top)
- `path` (text): Where it is, from the top: Garage / Tool shelf / Red toolbox
- `updated_at` (text): When it was last changed

**Example output**

```json
{
  "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 (`entry`, text, required): The entry's ID, from another Homebox step such as 'List scheduled maintenance'.
- Name (`name`, text): A new name for the entry.
- Description (`description`, text): New notes.
- Scheduled date (`scheduled_date`, date): A new day it's due.
- Completed date (`completed_date`, date): The day it was done, which marks it completed.
- Cost (`cost`, number): What it cost. From 0 to 1000000000.

**Outputs**

- `completed_date` (text): When it was done (YYYY-MM-DD), blank when not done
- `cost` (number): What it cost
- `days_until_due` (number): Days until it's due (negative when overdue); empty when done or not scheduled
- `description` (text): Notes about it
- `id` (text): The entry's ID, which other Homebox steps take
- `item_id` (text): The ID of the item it's for
- `item_name` (text): The name of the item it's for
- `link` (text): Where the item's maintenance log opens in Homebox
- `name` (text): What the maintenance is
- `scheduled_date` (text): When it's due (YYYY-MM-DD), blank when not scheduled
- `status` (text): scheduled or completed

**Example output**

```json
{
  "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 (`tag`, text, required): The tag: pick one, or give its ID or its name, such as Electronics.
- Name (`name`, text): A new name for the tag.
- Description (`description`, text): A new description.
- Colour (`color`, text): A new colour code, such as #3b82f6.
- Move inside (`parent`, text): The tag to move it into.

**Outputs**

- `color` (text): Its colour, such as #3b82f6 (blank when none)
- `description` (text): Its description
- `id` (text): The tag's ID, which other Homebox steps take
- `link` (text): Where the tag opens in Homebox
- `name` (text): The tag's name
- `parent` (text): The name of the tag it's inside
- `parent_id` (text): The ID of the tag it's inside (blank when none)

**Example output**

```json
{
  "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 (`item`, text, required): 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 (`file`, text, required): The file: upload one, pick one from an earlier step, or give a public https link to download.
- File name (`file_name`, text): The name to give it, with its ending, such as receipt.pdf. Leave blank to use the file's own name.
- Type (`attachment_type`, text): What the file is. Defaults to Attachment. One of: `attachment`, `photo`, `manual`, `warranty`, `receipt`. Default: `attachment`.
- Main photo (`primary`, true/false): Make this photo the one Homebox shows for the item. Default: `false`.

**Outputs**

- `attachment_count` (number): How many attachments the item has now
- `content_type` (text): The file's type, such as image/png
- `created_at` (text): When it was attached
- `id` (text): The attachment's ID, which other Homebox steps take
- `item_id` (text): The ID of the item it's attached to
- `item_name` (text): That item's name
- `link` (text): Where the item opens in Homebox
- `primary` (true/false): Whether it's the item's main photo
- `title` (text): Its title, usually the file's name
- `type` (text): What it is: attachment, photo, manual, warranty or receipt

**Example output**

```json
{
  "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"
}
```
