Homebox API

https://homebox.software/en/api
Admin
HomeBox is an open-source project designed to track, manage, and organize your things through its...
Tokens:86,723
Snippets:337
Trust Score:7.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /v1/users/self/settings

Source: https://homebox.software/en/api/operations/v1usersselfsettings/get

Retrieves the configuration settings for the currently authenticated user.

```APIDOC
## GET /v1/users/self/settings

### Description
Retrieves the settings object for the currently authenticated user.

### Method
GET

### Endpoint
/v1/users/self/settings

### Authorizations
- Bearer Token

### Response
#### Success Response (200)
- **item** (object) - The user settings object containing key-value pairs.

#### Response Example
{
  "theme": "dark",
  "language": "en",
  "notifications": true
}
```

--------------------------------

### GET /v1/groups/all

Source: https://homebox.software/en/api/operations/v1groupsall

Retrieves a list of all groups available in the system.

```APIDOC
## GET /v1/groups/all

### Description
Retrieves a comprehensive list of all groups defined within the Homebox application.

### Method
GET

### Endpoint
/v1/groups/all

### Authorizations
- Bearer Token

### Response
#### Success Response (200)
- **createdAt** (string) - Timestamp of group creation
- **currency** (string) - Currency associated with the group
- **id** (string) - Unique identifier for the group
- **name** (string) - Name of the group
- **updatedAt** (string) - Timestamp of last update

#### Response Example
[
  {
    "createdAt": "2023-01-01T00:00:00Z",
    "currency": "USD",
    "id": "group-123",
    "name": "Main Inventory",
    "updatedAt": "2023-01-01T00:00:00Z"
  }
]
```

--------------------------------

### GET /v1/templates

Source: https://homebox.software/en/api/operations/v1templates/get

Retrieves a list of all item templates defined in the system.

```APIDOC
## GET /v1/templates

### Description
Retrieves a list of all item templates available in the Homebox application.

### Method
GET

### Endpoint
/v1/templates

### Authorizations
- Bearer Token

### Response
#### Success Response (200)
- **createdAt** (string) - Timestamp of template creation
- **description** (string) - Description of the template
- **id** (string) - Unique identifier for the template
- **name** (string) - Name of the template
- **updatedAt** (string) - Timestamp of last template update

#### Response Example
[
  {
    "createdAt": "2023-01-01T00:00:00Z",
    "description": "Template for electronic items",
    "id": "temp-123",
    "name": "Electronics",
    "updatedAt": "2023-01-01T00:00:00Z"
  }
]
```

--------------------------------

### GET /assets

Source: https://homebox.software/en/api/operations/v1itemsid/put

Retrieve a list of assets including their purchase, warranty, and sale information.

```APIDOC
## GET /assets

### Description
Retrieves a comprehensive list of assets stored in the system, including details about their current location, purchase history, and warranty status.

### Method
GET

### Endpoint
/assets

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of items to return

### Request Example
GET /assets

### Response
#### Success Response (200)
- **id** (string) - Unique identifier
- **name** (string) - Asset name
- **purchasePrice** (number) - Price at time of purchase
- **warrantyExpires** (string) - Expiration date of warranty
- **soldPrice** (number) - Price at time of sale

#### Response Example
{
  "id": "123",
  "name": "Office Laptop",
  "purchasePrice": 1200.00,
  "warrantyExpires": "2025-12-31",
  "soldPrice": null
}
```

--------------------------------

### Get Currency Information

Source: https://homebox.software/en/api/operations/v1currency

Retrieves a list of available currencies with their details.

```APIDOC
## GET /v1/currency

### Description
Retrieves a list of available currencies with their details, including code, decimals, local name, currency name, and symbol.

### Method
GET

### Endpoint
/v1/currency

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **code** (string) - The currency code (e.g., "USD").
- **decimals** (integer) - The number of decimal places for the currency.
- **local** (string) - The local name of the currency.
- **name** (string) - The name of the currency.
- **symbol** (string) - The currency symbol (e.g., "$").

#### Response Example
```json
{
  "code": "USD",
  "decimals": 2,
  "local": "US dollar",
  "name": "United States Dollar",
  "symbol": "$"
}
```
```

--------------------------------

### GET /locations

Source: https://homebox.software/en/api/operations/v1itemsidattachmentsattachment_id/put

Retrieve a list of storage locations and their hierarchical structure.

```APIDOC
## GET /locations

### Description
Retrieves a list of locations, including nested child locations.

### Method
GET

### Endpoint
/locations

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the location
- **name** (string) - Name of the location
- **children** (Array<object>) - Recursive list of child locations

#### Response Example
{
  "id": "loc-1",
  "name": "Office",
  "children": []
}
```

--------------------------------

### GET /items

Source: https://homebox.software/en/api/operations/v1itemsid/get

Retrieves a list of inventory items with their associated metadata, purchase details, and warranty information.

```APIDOC
## GET /items

### Description
Retrieves a list of all inventory items stored in the system.

### Method
GET

### Endpoint
/items

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - Unique identifier
- **name** (string) - Item name
- **description** (string) - Item description
- **purchase_price** (number) - Price at purchase
- **quantity** (number) - Quantity of items
- **archived** (boolean) - Archived status

#### Response Example
{
  "id": "1",
  "name": "Laptop",
  "description": "Work laptop",
  "purchase_price": 1200.00,
  "quantity": 1,
  "archived": false
}
```

--------------------------------

### GET /v1/groups/invitations

Source: https://homebox.software/en/api/operations/v1groupsinvitations/get

Retrieves a list of all group invitations.

```APIDOC
## GET /v1/groups/invitations

### Description
Retrieves a list of all group invitations associated with the authenticated user.

### Method
GET

### Endpoint
/v1/groups/invitations

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **expiresAt** (string) - The expiration date and time of the invitation.
- **group** (object) - Information about the group the invitation is for.
  - **createdAt** (string) - The creation date and time of the group.
  - **currency** (string) - The currency associated with the group.
  - **id** (string) - The unique identifier of the group.
  - **name** (string) - The name of the group.
  - **updatedAt** (string) - The last update date and time of the group.
- **id** (string) - The unique identifier of the invitation.
- **uses** (integer) - The number of uses remaining for the invitation.

#### Response Example
```json
{
  "expiresAt": "2024-12-31T23:59:59Z",
  "group": {
    "createdAt": "2023-01-01T10:00:00Z",
    "currency": "USD",
    "id": "group_abc123",
    "name": "Project Alpha",
    "updatedAt": "2023-05-15T14:30:00Z"
  },
  "id": "inv_xyz789",
  "uses": 5
}
```
```

--------------------------------

### GET /v1/products/search-from-barcode

Source: https://homebox.software/en/api/operations/v1productssearch-from-barcode

Retrieves product details from the Homebox database using a provided barcode string.

```APIDOC
## GET /v1/products/search-from-barcode

### Description
Searches for a product using a barcode. Returns an array of matching objects containing item details and image references.

### Method
GET

### Endpoint
/v1/products/search-from-barcode

### Parameters
#### Query Parameters
- **data** (string) - Required - The barcode string to be searched.

### Request Example
GET /v1/products/search-from-barcode?data=123456789012

### Response
#### Success Response (200)
- **barcode** (string) - The scanned barcode.
- **imageBase64** (string) - Base64 encoded image of the product.
- **imageURL** (string) - URL to the product image.
- **item** (object) - Detailed item information including name, quantity, and manufacturer.

#### Response Example
{
  "barcode": "123456789012",
  "item": {
    "name": "Example Product",
    "quantity": 1,
    "manufacturer": "Example Corp"
  }
}
```

--------------------------------

### GET /assets/{id}

Source: https://homebox.software/en/api/operations/v1itemsid/put

Retrieve detailed information for a specific asset by its ID.

```APIDOC
## GET /assets/{id}

### Description
Fetches full details for a specific asset, including nested objects like tags, location, and warranty details.

### Method
GET

### Endpoint
/assets/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique ID of the asset

### Request Example
GET /assets/123

### Response
#### Success Response (200)
- **name** (string) - Asset name
- **serialNumber** (string) - Manufacturer serial number
- **tags** (array) - List of associated tags
- **warrantyDetails** (string) - Detailed warranty information

#### Response Example
{
  "id": "123",
  "name": "Office Laptop",
  "serialNumber": "SN-998877",
  "warrantyDetails": "3 year manufacturer warranty"
}
```

--------------------------------

### GET /v1/qrcode

Source: https://homebox.software/en/api/operations/v1qrcode

Generates a QR code based on the provided data string.

```APIDOC
## GET /v1/qrcode

### Description
Generates a QR code image based on the input data string provided in the query parameters.

### Method
GET

### Endpoint
/v1/qrcode

### Parameters
#### Query Parameters
- **data** (string) - Required - Data to be encoded into the QR code

### Request Example
GET /v1/qrcode?data=https://example.com

### Response
#### Success Response (200)
- **Content-Type** (image/jpeg) - The generated QR code image.

#### Response Example
[Binary Image Data]
```

--------------------------------

### GET /items

Source: https://homebox.software/en/api/operations/v1templatesidcreate-item

Retrieve details for inventory items including purchase information, warranty details, and metadata.

```APIDOC
## GET /items

### Description
Retrieves a list of inventory items with their associated purchase details, warranty information, and status.

### Method
GET

### Endpoint
/items

### Parameters
#### Query Parameters
- **id** (string) - Optional - Filter by item ID

### Response
#### Success Response (200)
- **id** (string) - Unique identifier
- **name** (string) - Item name
- **purchase_price** (number) - Price at purchase
- **serial_number** (string) - Manufacturer serial number
- **archived** (boolean) - Archived status

#### Response Example
{
  "id": "123",
  "name": "Example Item",
  "purchase_price": 99.99,
  "archived": false
}
```

--------------------------------

### GET /v1/groups

Source: https://homebox.software/en/api/operations/v1groups/get

Retrieves a list of groups from the Homebox system.

```APIDOC
## GET /v1/groups

### Description
Retrieves a list of all groups available in the system.

### Method
GET

### Endpoint
/v1/groups

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **createdAt** (string) - Timestamp of group creation
- **currency** (string) - Currency associated with the group
- **id** (string) - Unique identifier for the group
- **name** (string) - Name of the group
- **updatedAt** (string) - Timestamp of last update

#### Response Example
{
  "createdAt": "2023-01-01T00:00:00Z",
  "currency": "USD",
  "id": "group-123",
  "name": "Main Group",
  "updatedAt": "2023-01-01T00:00:00Z"
}
```

--------------------------------

### GET /items

Source: https://homebox.software/en/api/operations/v1itemsidattachmentsattachment_id/put

Retrieve a list of inventory items with their associated metadata, including purchase, warranty, and sale details.

```APIDOC
## GET /items

### Description
Retrieves a list of all inventory items stored in the system.

### Method
GET

### Endpoint
/items

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the item
- **name** (string) - Name of the item
- **description** (string) - Description of the item
- **purchase_price** (number) - Price at which the item was purchased
- **quantity** (number) - Quantity of the item
- **archived** (boolean) - Whether the item is archived

#### Response Example
{
  "id": "1",
  "name": "Laptop",
  "description": "Work laptop",
  "purchase_price": 1200.00,
  "quantity": 1,
  "archived": false
}
```

--------------------------------

### GET /api/item-templates

Source: https://homebox.software/en/api/operations/v1itemsid/get

Retrieves a list of item templates, including their default configurations and associated fields.

```APIDOC
## GET /api/item-templates

### Description
Retrieves a list of item templates used for creating new items. Includes default values for manufacturer, warranty, and quantity.

### Method
GET

### Endpoint
/api/item-templates

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - Unique identifier
- **default_name** (string) - Default name template
- **default_quantity** (number) - Default quantity
- **fields** (Array<object>) - Associated template fields

#### Response Example
{
  "id": "1",
  "default_name": "New Item",
  "default_quantity": 1,
  "fields": []
}
```

--------------------------------

### GET /groups

Source: https://homebox.software/en/api/operations/v1itemsidattachments

Retrieves group information and associated invitation tokens.

```APIDOC
## GET /groups

### Description
Retrieves details about a group, including its currency and associated invitation tokens.

### Method
GET

### Endpoint
/groups

### Response
#### Success Response (200)
- **id** (string) - Group ID
- **name** (string) - Group name
- **currency** (string) - Currency code
- **invitation_tokens** (Array<object>) - List of active invitation tokens

#### Response Example
{
  "id": "group_abc",
  "name": "Home",
  "currency": "USD"
}
```

--------------------------------

### GET /api/item_templates

Source: https://homebox.software/en/api/operations/v1itemsid/put

Retrieves a list of item templates, including default configurations for items, warranty settings, and associated fields.

```APIDOC
## GET /api/item_templates

### Description
Retrieves a list of item templates used to define the structure and default values for items created within the system.

### Method
GET

### Endpoint
/api/item_templates

### Parameters
#### Query Parameters
- **eager_load** (boolean) - Optional - If true, populates the edges for the item templates.

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the template.
- **name** (string) - Name of the template.
- **default_name** (string) - Default naming pattern for items.
- **default_quantity** (number) - Default quantity for items.
- **include_purchase_fields** (boolean) - Flag to include purchase details.

#### Response Example
{
  "id": "1",
  "name": "Electronics Template",
  "default_name": "New Item",
  "default_quantity": 1,
  "include_purchase_fields": true
}
```

--------------------------------

### GET /tags

Source: https://homebox.software/en/api/operations/v1templatesidcreate-item

Retrieve tag information used for categorizing items within the system.

```APIDOC
## GET /tags

### Description
Retrieves tags used to organize inventory items, including color coding and descriptions.

### Method
GET

### Endpoint
/tags

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - Unique identifier
- **name** (string) - Tag name
- **color** (string) - Hex color code
- **description** (string) - Tag description

#### Response Example
{
  "id": "tag-001",
  "name": "Electronics",
  "color": "#FF0000"
}
```

--------------------------------

### GET /items

Source: https://homebox.software/en/api/operations/v1itemsid/patch

Retrieves a list of inventory items including their metadata, attachments, and custom fields.

```APIDOC
## GET /items

### Description
Retrieves a list of items stored in the system, including nested edges like attachments and custom fields.

### Method
GET

### Endpoint
/items

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the item
- **name** (string) - Name of the item
- **asset_id** (integer) - Asset identifier
- **attachments** (Array<object>) - List of associated files
- **fields** (Array<object>) - Custom fields associated with the item

#### Response Example
{
  "id": "123",
  "name": "Office Chair",
  "asset_id": 1001,
  "attachments": [],
  "fields": []
}
```

--------------------------------

### GET /v1/notifiers

Source: https://homebox.software/en/api/operations/v1notifiers/get

Retrieves a list of all notifiers configured within the Homebox system.

```APIDOC
## GET /v1/notifiers

### Description
Retrieves a list of all notifiers configured for the authenticated user.

### Method
GET

### Endpoint
/v1/notifiers

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **createdAt** (string) - Timestamp of creation
- **groupId** (string) - Associated group ID
- **id** (string) - Unique identifier of the notifier
- **isActive** (boolean) - Status of the notifier
- **name** (string) - Name of the notifier
- **updatedAt** (string) - Timestamp of last update
- **url** (string) - Webhook or endpoint URL
- **userId** (string) - Owner user ID

#### Response Example
[
  {
    "createdAt": "2023-01-01T00:00:00Z",
    "groupId": "group-123",
    "id": "notif-456",
    "isActive": true,
    "name": "Discord Webhook",
    "updatedAt": "2023-01-01T00:00:00Z",
    "url": "https://discord.com/api/webhooks/...",
    "userId": "user-789"
  }
]
```

--------------------------------

### GET /item-templates

Source: https://homebox.software/en/api/operations/v1itemsidduplicate

Retrieves the structure and default fields for item templates used to create inventory items.

```APIDOC
## GET /item-templates

### Description
Returns a list of item templates, which define the default properties, descriptions, and custom fields for items.

### Method
GET

### Endpoint
/item-templates

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of templates to return

### Response
#### Success Response (200)
- **id** (string) - Unique identifier
- **default_name** (string) - Template name
- **default_quantity** (number) - Default quantity
- **fields** (Array<object>) - List of associated template fields

#### Response Example
{
  "id": "uuid-123",
  "default_name": "Electronics",
  "default_quantity": 1,
  "fields": []
}
```

--------------------------------

### GET /api/items

Source: https://homebox.software/en/api/operations/v1itemsid/put

Retrieves a list of items managed within the system, including their status, description, and associated metadata.

```APIDOC
## GET /api/items

### Description
Retrieves a list of items. Items represent the physical or digital assets tracked in the system.

### Method
GET

### Endpoint
/api/items

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the item.
- **name** (string) - Name of the item.
- **archived** (boolean) - Whether the item is archived.
- **manufacturer** (string) - Manufacturer of the item.
- **model_number** (string) - Model number of the item.

#### Response Example
{
  "id": "101",
  "name": "Laptop",
  "archived": false,
  "manufacturer": "BrandX",
  "model_number": "LX-200"
}
```

--------------------------------

### GET /api/items

Source: https://homebox.software/en/api/operations/v1itemsidduplicate

Retrieves details about an inventory item, including purchase information, warranty details, and metadata.

```APIDOC
## GET /api/items/{id}

### Description
Retrieves the full details of a specific inventory item, including its status, purchase history, and warranty information.

### Method
GET

### Endpoint
/api/items/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the item.

### Response
#### Success Response (200)
- **id** (string) - Unique identifier
- **name** (string) - Item name
- **description** (string) - Item description
- **purchase_price** (number) - Price paid for the item
- **serial_number** (string) - Manufacturer serial number
- **archived** (boolean) - Whether the item is archived
- **updated_at** (string) - Last modification timestamp

#### Response Example
{
  "id": "123",
  "name": "Laptop",
  "purchase_price": 1200.00,
  "archived": false
}
```

--------------------------------

### GET /api/item_templates

Source: https://homebox.software/en/api/operations/v1itemsidattachmentsattachment_id/put

Retrieves a list of item templates used for defining default properties for inventory items.

```APIDOC
## GET /api/item_templates

### Description
Retrieves a list of available item templates. These templates define default values for items such as name, quantity, and warranty details.

### Method
GET

### Endpoint
/api/item_templates

### Parameters
#### Query Parameters
- **eager_load** (boolean) - Optional - If true, populates the 'edges' field with related data.

### Response
#### Success Response (200)
- **id** (string) - Unique identifier of the template.
- **name** (string) - Name of the template.
- **default_name** (string) - Default name pattern for items.
- **default_quantity** (number) - Default quantity for items.
- **edges** (object) - Related graph nodes.

#### Response Example
{
  "id": "1",
  "name": "Electronics Template",
  "default_quantity": 1,
  "edges": {}
}
```

--------------------------------

### GET /api/item-templates

Source: https://homebox.software/en/api/operations/v1itemsid/get

Retrieves item templates used for standardizing item creation, including default values and custom fields.

```APIDOC
## GET /api/item-templates

### Description
Retrieves item templates that define default attributes for new items, such as manufacturer, warranty details, and custom fields.

### Method
GET

### Endpoint
/api/item-templates

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Response
#### Success Response (200)
- **id** (string) - Template ID
- **name** (string) - Template name
- **default_name** (string) - Default item name template
- **default_quantity** (number) - Default quantity
- **fields** (Array<object>) - List of custom fields associated with the template

#### Response Example
{
  "id": "uuid",
  "name": "Electronics",
  "default_quantity": 1,
  "fields": []
}
```

--------------------------------

### GET /v1/tags

Source: https://homebox.software/en/api/operations/v1tags/get

Retrieves a comprehensive list of all tags defined in the Homebox system, including their metadata and hierarchical relationships.

```APIDOC
## GET /v1/tags

### Description
Retrieves a list of all tags available in the system. Each tag object includes details such as name, description, color, and parent-child relationships.

### Method
GET

### Endpoint
/v1/tags

### Parameters
None

### Request Example
GET /v1/tags

### Response
#### Success Response (200)
- **children** (Array<object>) - List of child tags associated with the tag.
- **color** (string) - The hex color code for the tag.
- **createdAt** (string) - ISO timestamp of creation.
- **description** (string) - Detailed description of the tag.
- **icon** (string) - Icon identifier for the tag.
- **id** (string) - Unique identifier for the tag.
- **name** (string) - The display name of the tag.
- **parentId** (string) - The ID of the parent tag, if applicable.
- **updatedAt** (string) - ISO timestamp of the last update.

#### Response Example
[
  {
    "id": "tag-123",
    "name": "Electronics",
    "color": "#FF0000",
    "description": "Electronic devices",
    "parentId": null,
    "children": []
  }
]
```

--------------------------------

### Initialize Asset Field Value

Source: https://homebox.software/en/api/operations/v1itemsid/patch

A simple example showing the initialization of an asset field value, typically used when interacting with the API's data structures.

```json
{
  "id": "123",
  "name": "Example Asset",
  "numberValue": 0
}
```

--------------------------------

### GET /locations

Source: https://homebox.software/en/api/operations/v1itemsid/patch

Retrieves location data associated with assets.

```APIDOC
## GET /locations

### Description
Retrieve information about asset locations.

### Method
GET

### Endpoint
/locations

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - Location unique identifier
- **name** (string) - Name of the location
- **description** (string) - Description of the location

#### Response Example
{
  "id": "loc-001",
  "name": "Main Office",
  "description": "Primary storage facility"
}
```

--------------------------------

### Application Info API

Source: https://homebox.software/en/api/operations/v1status

Retrieves the current status and build information of the Homebox application.

```APIDOC
## GET /v1/status

### Description
Retrieves the current status and build information of the Homebox application.

### Method
GET

### Endpoint
/v1/status

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **allowRegistration** (boolean) - Indicates if new user registration is allowed.
- **build** (object) - Contains build-related information.
  - **buildTime** (string) - The time when the application was built.
  - **commit** (string) - The commit hash of the build.
  - **version** (string) - The version of the build.
- **demo** (boolean) - Indicates if the application is running in demo mode.
- **health** (boolean) - Indicates the overall health status of the application.
- **labelPrinting** (boolean) - Indicates if label printing is enabled.
- **latest** (object) - Information about the latest available version.
  - **date** (string) - The release date of the latest version.
  - **version** (string) - The version number of the latest release.
  - **message** (string) - A message associated with the latest release.
- **oidc** (object) - OpenID Connect configuration details.
  - **allowLocal** (boolean) - Whether local OIDC authentication is allowed.
  - **autoRedirect** (boolean) - Whether to automatically redirect for OIDC authentication.
  - **buttonText** (string) - The text displayed on the OIDC login button.
  - **enabled** (boolean) - Whether OIDC authentication is enabled.
- **telemetry** (object) - Telemetry settings.
  - **enabled** (boolean) - Whether telemetry is enabled.
  - **title** (string) - The title for telemetry settings.
  - **versions** (Array<string>) - A list of supported telemetry versions.

#### Response Example
```json
{
  "allowRegistration": true,
  "build": {
    "buildTime": "2023-10-27T10:00:00Z",
    "commit": "abcdef1234567890",
    "version": "1.0.0"
  },
  "demo": false,
  "health": true,
  "labelPrinting": true,
  "latest": {
    "date": "2023-10-26T00:00:00Z",
    "version": "1.1.0",
    "message": "Bug fixes and performance improvements."
  },
  "oidc": {
    "allowLocal": false,
    "autoRedirect": true,
    "buttonText": "Login with SSO",
    "enabled": true
  },
  "telemetry": {
    "enabled": true,
    "title": "Usage Statistics",
    "versions": ["v1", "v2"]
  }
}
```
```

--------------------------------

### GET /api/groups

Source: https://homebox.software/en/api/operations/v1itemsid/get

Retrieves group information and associated invitation tokens.

```APIDOC
## GET /api/groups

### Description
Fetch group details including currency settings and associated invitation tokens.

### Method
GET

### Endpoint
/api/groups

### Response
#### Success Response (200)
- **id** (string) - Group ID
- **name** (string) - Group name
- **currency** (string) - Currency code
- **invitation_tokens** (Array<object>) - List of active invitation tokens

#### Response Example
{
  "id": "g1",
  "name": "Home",
  "currency": "USD",
  "invitation_tokens": []
}
```

--------------------------------

### Register New User

Source: https://homebox.software/en/api/operations/v1usersregister

Allows for the registration of a new user within the Homebox system.

```APIDOC
## POST /v1/users/register

### Description
Registers a new user with the provided credentials.

### Method
POST

### Endpoint
/v1/users/register

### Parameters
#### Request Body
- **email** (string) - Required - The email address of the user.
- **name** (string) - Required - The name of the user.
- **password** (string) - Required - The password for the user account.
- **token** (string) - Required - A security token for the registration process.

### Request Example
{
  "email": "user@example.com",
  "name": "John Doe",
  "password": "securepassword123",
  "token": "a1b2c3d4e5f6"
}

### Response
#### Success Response (204)
No Content

#### Error Response (403)
- **message** (string) - Local login is not enabled.
```

--------------------------------

### GET /attachments

Source: https://homebox.software/en/api/operations/v1itemsid/patch

Retrieves details for a specific attachment associated with an item.

```APIDOC
## GET /attachments/{id}

### Description
Fetches metadata for a specific attachment, including path, mime type, and creation date.

### Method
GET

### Endpoint
/attachments/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the attachment

### Response
#### Success Response (200)
- **id** (string) - Attachment ID
- **path** (string) - File storage path
- **mimeType** (string) - File MIME type
- **createdAt** (string) - Timestamp of creation

#### Response Example
{
  "id": "att_001",
  "path": "/files/image.jpg",
  "mimeType": "image/jpeg",
  "createdAt": "2023-10-01T12:00:00Z"
}
```

--------------------------------

### GET /api/item_templates

Source: https://homebox.software/en/api/operations/v1itemsid/patch

Retrieves item templates used for standardizing item creation.

```APIDOC
## GET /api/item_templates

### Description
Retrieves a list of item templates, which define default values and custom fields for new items.

### Method
GET

### Endpoint
/api/item_templates

### Response
#### Success Response (200)
- **id** (string) - Template ID
- **name** (string) - Template name
- **default_name** (string) - Default name template
- **default_quantity** (number) - Default quantity
- **fields** (Array<object>) - List of custom fields associated with the template

#### Response Example
{
  "id": "uuid",
  "name": "Electronics",
  "default_quantity": 1,
  "fields": []
}
```

--------------------------------

### Settings Object Structure

Source: https://homebox.software/en/api/operations/v1itemsidattachmentsattachment_id/put

Details the structure of the settings object.

```APIDOC
## Settings Object

### Description
Represents user or system settings.

### Fields
- **superuser** (boolean) - Indicates if the settings are for a superuser.
- **updated_at** (string) - Timestamp of the last settings update.
- **token** (string) - Authentication token.
- **groups** (Array<object>) - Associated groups.
- **created_at** (string) - Timestamp of settings creation.
- **currency** (string) - Default currency.
- **edges** (object) - Relations/edges for other nodes.
- **id** (string) - ID of the settings entry.
- **name** (string) - Name associated with the settings.
- **notifiers** (Array<object>) - List of notifiers.
- **email** (string) - Email address.
- **is_superuser** (boolean) - Indicates superuser status.
- **oidc_issuer** (string) - OIDC issuer.
- **oidc_subject** (string) - OIDC subject.
- **role** (string) - Role assigned. Allowed values: user, user, owner.
- **settings** (object) - Nested settings object.
- **_key_** (any) - Additional properties.
```

--------------------------------

### GET /api/invitation_tokens

Source: https://homebox.software/en/api/operations/v1itemsid/patch

Retrieves a list of invitation tokens for group access management.

```APIDOC
## GET /api/invitation_tokens

### Description
Retrieves a list of group invitation tokens including their expiration, usage limits, and associated group metadata.

### Method
GET

### Endpoint
/api/invitation_tokens

### Response
#### Success Response (200)
- **id** (string) - ID of the token
- **token** (Array<integer>) - The token value
- **expires_at** (string) - Expiration timestamp
- **uses** (integer) - Number of uses
- **created_at** (string) - Creation timestamp
- **updated_at** (string) - Last update timestamp

#### Response Example
{
  "id": "uuid",
  "token": [1, 2, 3],
  "expires_at": "2023-12-31T23:59:59Z",
  "uses": 1
}
```

--------------------------------

### GET /template-fields

Source: https://homebox.software/en/api/operations/v1itemsidduplicate

Retrieves the definition of custom fields associated with item templates.

```APIDOC
## GET /template-fields

### Description
Retrieves the configuration for custom fields that can be attached to item templates.

### Method
GET

### Endpoint
/template-fields

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - Field ID
- **name** (string) - Field label
- **type** (string) - Field type (text, number, boolean, time)
- **number_value** (integer) - Default numeric value if applicable

#### Response Example
{
  "id": "field-456",
  "name": "Purchase Date",
  "type": "time"
}
```

--------------------------------

### GET /items

Source: https://homebox.software/en/api/operations/v1templatesidcreate-item

Retrieves a list of inventory items including details like serial numbers, warranty information, and purchase history.

```APIDOC
## GET /items

### Description
Retrieve a list of items stored in the system. Each item contains metadata such as manufacturer, model number, and warranty details.

### Method
GET

### Endpoint
/items

### Parameters
None

### Request Example
GET /items

### Response
#### Success Response (200)
- **items** (Array<object>) - List of items
- **id** (string) - Unique identifier
- **name** (string) - Name of the item
- **serial_number** (string) - Item serial number
- **manufacturer** (string) - Item manufacturer

#### Response Example
{
  "items": [
    {
      "id": "123",
      "name": "Laptop",
      "serial_number": "SN-999",
      "manufacturer": "TechCorp"
    }
  ]
}
```

--------------------------------

### User and Asset Management Models

Source: https://homebox.software/en/api/operations/v1itemsidduplicate

Defines the data structures for users, items, and inventory assets.

```APIDOC
## GET /api/v1/items

### Description
Retrieves a list of items within the inventory, including details about their purchase, warranty, and physical location.

### Method
GET

### Endpoint
/api/v1/items

### Parameters
#### Query Parameters
- **id** (string) - Optional - Filter by item ID

### Response
#### Success Response (200)
- **items** (Array<object>) - List of inventory items
- **name** (string) - Name of the item
- **manufacturer** (string) - Manufacturer name
- **purchase_price** (number) - Price at time of purchase
- **warranty_expires** (string) - Expiration date of the warranty

#### Response Example
{
  "items": [
    {
      "id": "uuid-123",
      "name": "Example Item",
      "manufacturer": "Brand",
      "purchase_price": 99.99,
      "warranty_expires": "2025-12-31"
    }
  ]
}

## GET /api/v1/users

### Description
Retrieves user profile information including roles and OIDC authentication details.

### Method
GET

### Endpoint
/api/v1/users

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - User ID
- **name** (string) - User display name
- **role** (string) - User role (user, owner)
- **is_superuser** (boolean) - Superuser status

#### Response Example
{
  "id": "user-uuid",
  "name": "John Doe",
  "role": "owner",
  "is_superuser": true
}
```

--------------------------------

### User and Settings

Source: https://homebox.software/en/api/operations/v1itemsidattachmentsattachment_id/put

Details related to user accounts, their settings, and superuser status.

```APIDOC
## User and Settings

### Description
This section describes the user-related fields and their associated settings, including superuser privileges.

### Fields
- **settings** (object) - Holds the value of the 'settings' field. Can contain additional properties.
  - **_key_** (any) - Additional properties.
  - **superuser** (boolean) - Indicates if the user has superuser privileges.
- **superuser** (boolean) - Superuser holds the value of the 'superuser' field.
- **updated_at** (string) - UpdatedAt holds the value of the 'updated_at' field.
- **id** (string) - ID of the entity.
- **is_active** (boolean) - IsActive holds the value of the 'is_active' field.
- **name** (string) - Name holds the value of the 'name' field.
- **user_id** (string) - UserID holds the value of the 'user_id' field.
- **email** (string) - Email holds the value of the 'email' field.
- **is_superuser** (boolean) - IsSuperuser holds the value of the 'is_superuser' field.
- **oidc_issuer** (string) - OidcIssuer holds the value of the 'oidc_issuer' field.
- **oidc_subject** (string) - OidcSubject holds the value of the 'oidc_subject' field.
- **role** (string) - Role holds the value of the 'role' field. Allowed values: user, owner.
```

--------------------------------

### Get User Self

Source: https://homebox.software/en/api/operations/v1usersself/get

Retrieves the currently authenticated user's information.

```APIDOC
## GET /v1/users/self

### Description
Retrieves the details of the currently authenticated user.

### Method
GET

### Endpoint
/v1/users/self

### Authorizations
- Bearer token authentication is required.

### Responses
#### Success Response (200)
- **defaultGroupId** (string) - The default group ID for the user.
- **email** (string) - The email address of the user.
- **groupIds** (Array<string>) - A list of group IDs the user belongs to.
- **id** (string) - The unique identifier for the user.
- **isOwner** (boolean) - Indicates if the user is an owner.
- **isSuperuser** (boolean) - Indicates if the user has superuser privileges.
- **name** (string) - The name of the user.
- **oidcIssuer** (string) - The OIDC issuer URL if applicable.
- **oidcSubject** (string) - The OIDC subject identifier if applicable.

#### Response Example
```json
{
  "defaultGroupId": "group123",
  "email": "user@example.com",
  "groupIds": ["group123", "group456"],
  "id": "user789",
  "isOwner": true,
  "isSuperuser": false,
  "name": "John Doe",
  "oidcIssuer": "https://accounts.google.com",
  "oidcSubject": "sub12345"
}
```
```

--------------------------------

### POST /v1/actions/create-missing-thumbnails

Source: https://homebox.software/en/api/operations/v1actionscreate-missing-thumbnails

Triggers the creation of thumbnails for all items missing them.

```APIDOC
## POST /v1/actions/create-missing-thumbnails

### Description
Creates thumbnails for items that are missing them. This is an administrative action to ensure media consistency across the platform.

### Method
POST

### Endpoint
/v1/actions/create-missing-thumbnails

### Authorizations
- **Bearer Token** (Required)

### Request Body
- None

### Request Example
{}

### Response
#### Success Response (200)
- **completed** (integer) - The number of thumbnails successfully created or processed.

#### Response Example
{
  "completed": 5
}
```

--------------------------------

### User Settings Structure

Source: https://homebox.software/en/api/operations/v1itemsid/patch

Details the structure for user settings, including authentication and role information.

```APIDOC
## User Settings Structure

### Description
Defines the structure for user settings, encompassing authentication credentials, roles, and superuser status.

### Fields
- **id** (string) - ID of the ent.
- **name** (string) - Name holds the value of the “name” field.
- **email** (string) - Email holds the value of the “email” field.
- **is_superuser** (boolean) - IsSuperuser holds the value of the “is_superuser” field.
- **superuser** (boolean) - Superuser holds the value of the “superuser” field.
- **oidc_issuer** (string) - OidcIssuer holds the value of the “oidc_issuer” field.
- **oidc_subject** (string) - OidcSubject holds the value of the “oidc_subject” field.
- **role** (string) - Role holds the value of the “role” field. Allowed values: user, owner.
- **created_at** (string) - CreatedAt holds the value of the “created_at” field.
- **updated_at** (string) - UpdatedAt holds the value of the “updated_at” field.

### Edges
- **groups** (Array<object>) - Groups holds the value of the groups edge.
- **notifiers** (Array<object>) - Notifiers holds the value of the notifiers edge.
- **settings** (object) - Settings holds the value of the “settings” field.
- **tags** (Array<object>) - Tags holds the value of the tags edge.
```
Tokens:
Raw