HomeBox

HomeBox API

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

GitHub OpenAPI

Operations 93

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 #
PUT /v1/notifiers/{id} Update Notifier #
GET /v1/products/search-from-barcode Search EAN from Barcode #
GET /v1/qrcode Create QR Code #
GET /v1/reporting/bill-of-materials Export Bill of Materials #
GET /v1/status Get API status #
GET /v1/tags Get All Tags #
POST /v1/tags Create Tag #
DELETE /v1/tags/{id} Delete Tag #
GET /v1/tags/{id} Get Tag #
PUT /v1/tags/{id} Update Tag #
GET /v1/templates Get All Templates #
POST /v1/templates Create Entity Template #
DELETE /v1/templates/{id} Delete Entity Template #
GET /v1/templates/{id} Get Entity Template #
PUT /v1/templates/{id} Update Entity Template #
POST /v1/templates/{id}/create-item Create Item from Template #
PUT /v1/users/change-password User Change Password #
POST /v1/users/forgot-password Request Password Reset #
POST /v1/users/login User Login #
GET /v1/users/login/oidc OIDC Login Initiation #
GET /v1/users/login/oidc/callback OIDC Callback Handler #
POST /v1/users/logout User Logout #
POST /v1/users/logout/all Log Out Of All Sessions #
GET /v1/users/refresh User Token Refresh #
POST /v1/users/register Register New User #
DELETE /v1/users/self Delete Account #
GET /v1/users/self Get User Self #
PUT /v1/users/self Update Account #
GET /v1/users/self/api-keys Get API Keys #
POST /v1/users/self/api-keys Create API Key #
DELETE /v1/users/self/api-keys/{id} Delete API Key #
GET /v1/users/self/settings Get user settings #
PUT /v1/users/self/settings Update user settings #

Specifications

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

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/homebox-software/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/homebox-software:homebox-software-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

homebox-software-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: HomeBox API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 93 operation(s) read from 1 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; HomeBox has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 93
    pages-with-code: 0
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:


# --- truncated at 32 KB (34 KB total) ---
# Full source: https://artifacts.apis.io/homebox-software/openapi/_ae-authored/homebox-software-openapi-generated.yml