# HomeBox API

**Canonical:** https://apis.io/apis/homebox-software/homebox-software-api/  
**Provider:** HomeBox — https://apis.io/providers/homebox-software/  
**Documentation:** https://homebox.software/en/api

HomeBox API is published by [HomeBox](https://apis.io/providers/homebox-software/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. The published artifact set on APIs.io includes an OpenAPI specification.

HomeBox API as documented publicly: 93 operations. Contract generated from the documentation by API Evangelist (2026-10-28); not the provider's own document.

## Operations (60 of 93)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/actions/create-missing-thumbnails` | Create Missing Thumbnails |
| POST | `/v1/actions/ensure-asset-ids` | Ensure Asset IDs |
| POST | `/v1/actions/ensure-import-refs` | Ensures Import Refs |
| POST | `/v1/actions/set-primary-photos` | Set Primary Photos |
| POST | `/v1/actions/wipe-inventory` | Wipe Inventory |
| POST | `/v1/actions/zero-item-time-fields` | Zero Out Time Fields |
| GET | `/v1/assets/{id}` | Get Asset by ID |
| GET | `/v1/currencies` | Base Currency |
| GET | `/v1/entities` | Query all entities |
| POST | `/v1/entities` | Create entity |
| GET | `/v1/entities/fields/values` | Get all custom field values |
| POST | `/v1/entities/import` | Import entities |
| DELETE | `/v1/entities/{id}` | Delete entity |
| GET | `/v1/entities/{id}` | Get entity |
| PATCH | `/v1/entities/{id}` | Patch entity |
| PUT | `/v1/entities/{id}` | Update entity |
| POST | `/v1/entities/{id}/attachments` | Create Entity Attachment |
| POST | `/v1/entities/{id}/attachments/external` | Create External Link Attachment |
| DELETE | `/v1/entities/{id}/attachments/{attachmentId}` | Delete Entity Attachment |
| GET | `/v1/entities/{id}/attachments/{attachmentId}` | Get Entity Attachment |
| PUT | `/v1/entities/{id}/attachments/{attachmentId}` | Update Entity Attachment |
| POST | `/v1/entities/{id}/duplicate` | Duplicate Entity |
| GET | `/v1/entities/{id}/maintenance` | Get Maintenance Log |
| POST | `/v1/entities/{id}/maintenance` | Create Maintenance Entry |
| GET | `/v1/entities/{id}/path` | Get the full path of an entity |
| GET | `/v1/entity-types` | Get All Entity Types |
| POST | `/v1/entity-types` | Create Entity Type |
| DELETE | `/v1/entity-types/{id}` | Delete Entity Type |
| PUT | `/v1/entity-types/{id}` | Update Entity Type |
| GET | `/v1/group/exports` | Get Group Exports |
| POST | `/v1/group/exports` | Create Group Export |
| DELETE | `/v1/group/exports/{id}` | Delete Group Export |
| GET | `/v1/group/exports/{id}` | Get Group Export |
| GET | `/v1/group/exports/{id}/download` | Download Group Export |
| POST | `/v1/group/import` | Import Group |
| DELETE | `/v1/groups` | Delete Groups |
| GET | `/v1/groups` | Get All Groups |
| POST | `/v1/groups` | Create Group |
| PUT | `/v1/groups` | Update Groups |
| GET | `/v1/groups/all` | Get All Groups (all) |
| GET | `/v1/groups/invitations` | GET /v1/groups/invitations |
| POST | `/v1/groups/invitations` | POST /v1/groups/invitations |
| DELETE | `/v1/groups/invitations/{id}` | DELETE /v1/groups/invitations/{id} |
| POST | `/v1/groups/invitations/{id}` | POST /v1/groups/invitations/{id} |
| GET | `/v1/groups/members` | GET /v1/groups/members |
| DELETE | `/v1/groups/members/{userId}` | DELETE /v1/groups/members/{userId} |
| GET | `/v1/groups/statistics` | GET /v1/groups/statistics |
| GET | `/v1/groups/statistics/locations` | GET /v1/groups/statistics/locations |
| GET | `/v1/groups/statistics/purchase-price` | GET /v1/groups/statistics/purchase-price |
| GET | `/v1/groups/statistics/tags` | GET /v1/groups/statistics/tags |
| GET | `/v1/labelmaker/asset/{id}` | Get Asset label |
| GET | `/v1/labelmaker/item/{id}` | Get Item label |
| GET | `/v1/labelmaker/location/{id}` | GET /v1/labelmaker/location/{id} |
| GET | `/v1/maintenance` | GET /v1/maintenance |
| DELETE | `/v1/maintenance/{id}` | Delete Maintenance Entry |
| PUT | `/v1/maintenance/{id}` | Update Maintenance Entry |
| GET | `/v1/notifiers` | Get Notifiers |
| POST | `/v1/notifiers` | Create Notifier |
| POST | `/v1/notifiers/test` | Test Notifier |
| DELETE | `/v1/notifiers/{id}` | Delete a Notifier |

…and 33 more operations. They are listed in full on the page.

## Machine-readable artifacts (2)

- **OpenAPI** — https://artifacts.apis.io/homebox-software/openapi/_ae-authored/homebox-software-openapi-generated.yml
- **APIsJSON** — https://artifacts.apis.io/homebox-software/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/homebox-software/homebox-software-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/homebox-software/.