# API Summary: Homebox API
**Summary:** Create Missing Thumbnails
**Description:** Creates thumbnails for items that are missing them
- **200**: OK
**Schema:**
Object with properties:
- `completed` (integer): No description
---
**Summary:** Ensure Asset IDs
**Description:** Ensures all items in the database have an asset ID
- **200**: OK
**Schema:**
Object with properties:
- `completed` (integer): No description
---
**Summary:** Ensures Import Refs
**Description:** Ensures all items in the database have an import ref
- **200**: OK
**Schema:**
Object with properties:
- `completed` (integer): No description
---
**Summary:** Set Primary Photos
**Description:** Sets the first photo of each item as the primary photo
- **200**: OK
**Schema:**
Object with properties:
- `completed` (integer): No description
---
**Summary:** Zero Out Time Fields
**Description:** Resets all item date fields to the beginning of the day
- **200**: OK
**Schema:**
Object with properties:
- `completed` (integer): No description
---
**Summary:** Get Item by Asset ID
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Asset ID |
- **200**: OK
**Schema:**
Object with properties:
- `items` (array): No description
- `page` (integer): No description
- `pageSize` (integer): No description
- `total` (integer): No description
---
**Summary:** Currency
- **200**: OK
**Schema:**
Object with properties:
- `code` (string): No description
- `local` (string): No description
- `name` (string): No description
- `symbol` (string): No description
---
**Summary:** Get Group
- **200**: OK
**Schema:**
Object with properties:
- `createdAt` (string): No description
- `currency` (string): No description
- `id` (string): No description
- `name` (string): No description
- `updatedAt` (string): No description
---
**Summary:** Update Group
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `payload` | body | True | object | User Data |
Object with properties:
- `currency` (string): No description
- `name` (string): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `createdAt` (string): No description
- `currency` (string): No description
- `id` (string): No description
- `name` (string): No description
- `updatedAt` (string): No description
---
**Summary:** Create Group Invitation
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `payload` | body | True | object | User Data |
Object with properties:
- `expiresAt` (string): No description
- `uses` (integer): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `expiresAt` (string): No description
- `token` (string): No description
- `uses` (integer): No description
---
**Summary:** Get Group Statistics
- **200**: OK
**Schema:**
Object with properties:
- `totalItemPrice` (number): No description
- `totalItems` (integer): No description
- `totalLabels` (integer): No description
- `totalLocations` (integer): No description
- `totalUsers` (integer): No description
- `totalWithWarranty` (integer): No description
---
**Summary:** Get Label Statistics
- **200**: OK
**Schema:**
Array of:
Object with properties:
- `id` (string): No description
- `name` (string): No description
- `total` (number): No description
---
**Summary:** Get Location Statistics
- **200**: OK
**Schema:**
Array of:
Object with properties:
- `id` (string): No description
- `name` (string): No description
- `total` (number): No description
---
**Summary:** Get Purchase Price Statistics
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `start` | query | False | string | start date |
| `end` | query | False | string | end date |
- **200**: OK
**Schema:**
Object with properties:
- `end` (string): No description
- `entries` (array): No description
- `start` (string): No description
- `valueAtEnd` (number): No description
- `valueAtStart` (number): No description
---
**Summary:** Query All Items
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `q` | query | False | string | search string |
| `page` | query | False | integer | page number |
| `pageSize` | query | False | integer | items per page |
| `labels` | query | False | array | label Ids |
| `locations` | query | False | array | location Ids |
| `parentIds` | query | False | array | parent Ids |
- **200**: OK
**Schema:**
Object with properties:
- `items` (array): No description
- `page` (integer): No description
- `pageSize` (integer): No description
- `total` (integer): No description
---
**Summary:** Create Item
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `payload` | body | True | object | Item Data |
Object with properties:
- `description` (string): No description
- `labelIds` (array): No description
- `locationId` (string): Edges
- `name` (string): No description
- `parentId` (string): No description
- `quantity` (integer): No description
```
- **201**: Created
**Schema:**
Object with properties:
- `archived` (boolean): No description
- `assetId` (string): No description
- `createdAt` (string): No description
- `description` (string): No description
- `id` (string): No description
- `imageId` (string): No description
- `insured` (boolean): No description
- `labels` (array): No description
- `location` (any): Edges
- `name` (string): No description
- `purchasePrice` (number): No description
- `quantity` (integer): No description
- `soldTime` (string): Sale details
- `thumbnailId` (string): No description
- `updatedAt` (string): No description
---
**Summary:** Export Items
- **200**: text/csv
**Schema:**
string
---
**Summary:** Get All Custom Field Names
- **200**: OK
**Schema:**
Array of:
string
---
**Summary:** Get All Custom Field Values
- **200**: OK
**Schema:**
Array of:
string
---
**Summary:** Import Items
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `csv` | formData | True | file | Image to upload |
| Name | Type | Description |
|------|------|-------------|
| `csv` | file | Image to upload |
- **204**: No Content
---
**Summary:** Get Item
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
- **200**: OK
**Schema:**
Object with properties:
- `archived` (boolean): No description
- `assetId` (string): No description
- `attachments` (array): No description
- `createdAt` (string): No description
- `description` (string): No description
- `fields` (array): No description
- `id` (string): No description
- `imageId` (string): No description
- `insured` (boolean): No description
- `labels` (array): No description
- `lifetimeWarranty` (boolean): Warranty
- `location` (any): Edges
- `manufacturer` (string): No description
- `modelNumber` (string): No description
- `name` (string): No description
- `notes` (string): Extras
- `parent` (any): No description
- `purchaseFrom` (string): No description
- `purchasePrice` (number): No description
- `purchaseTime` (string): Purchase
- `quantity` (integer): No description
- `serialNumber` (string): No description
- `soldNotes` (string): No description
- `soldPrice` (number): No description
- `soldTime` (string): Sold
- `soldTo` (string): No description
- `syncChildItemsLocations` (boolean): No description
- `thumbnailId` (string): No description
- `updatedAt` (string): No description
- `warrantyDetails` (string): No description
- `warrantyExpires` (string): No description
---
**Summary:** Update Item
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
| `payload` | body | True | object | Item Data |
Object with properties:
- `archived` (boolean): No description
- `assetId` (string): No description
- `description` (string): No description
- `fields` (array): No description
- `id` (string): No description
- `insured` (boolean): No description
- `labelIds` (array): No description
- `lifetimeWarranty` (boolean): Warranty
- `locationId` (string): Edges
- `manufacturer` (string): No description
- `modelNumber` (string): No description
- `name` (string): No description
- `notes` (string): Extras
- `parentId` (string): No description
- `purchaseFrom` (string): No description
- `purchasePrice` (number): No description
- `purchaseTime` (string): Purchase
- `quantity` (integer): No description
- `serialNumber` (string): Identifications
- `soldNotes` (string): No description
- `soldPrice` (number): No description
- `soldTime` (string): Sold
- `soldTo` (string): No description
- `syncChildItemsLocations` (boolean): No description
- `warrantyDetails` (string): No description
- `warrantyExpires` (string): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `archived` (boolean): No description
- `assetId` (string): No description
- `attachments` (array): No description
- `createdAt` (string): No description
- `description` (string): No description
- `fields` (array): No description
- `id` (string): No description
- `imageId` (string): No description
- `insured` (boolean): No description
- `labels` (array): No description
- `lifetimeWarranty` (boolean): Warranty
- `location` (any): Edges
- `manufacturer` (string): No description
- `modelNumber` (string): No description
- `name` (string): No description
- `notes` (string): Extras
- `parent` (any): No description
- `purchaseFrom` (string): No description
- `purchasePrice` (number): No description
- `purchaseTime` (string): Purchase
- `quantity` (integer): No description
- `serialNumber` (string): No description
- `soldNotes` (string): No description
- `soldPrice` (number): No description
- `soldTime` (string): Sold
- `soldTo` (string): No description
- `syncChildItemsLocations` (boolean): No description
- `thumbnailId` (string): No description
- `updatedAt` (string): No description
- `warrantyDetails` (string): No description
- `warrantyExpires` (string): No description
---
**Summary:** Delete Item
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
- **204**: No Content
---
**Summary:** Update Item
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
| `payload` | body | True | object | Item Data |
Object with properties:
- `id` (string): No description
- `quantity` (integer): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `archived` (boolean): No description
- `assetId` (string): No description
- `attachments` (array): No description
- `createdAt` (string): No description
- `description` (string): No description
- `fields` (array): No description
- `id` (string): No description
- `imageId` (string): No description
- `insured` (boolean): No description
- `labels` (array): No description
- `lifetimeWarranty` (boolean): Warranty
- `location` (any): Edges
- `manufacturer` (string): No description
- `modelNumber` (string): No description
- `name` (string): No description
- `notes` (string): Extras
- `parent` (any): No description
- `purchaseFrom` (string): No description
- `purchasePrice` (number): No description
- `purchaseTime` (string): Purchase
- `quantity` (integer): No description
- `serialNumber` (string): No description
- `soldNotes` (string): No description
- `soldPrice` (number): No description
- `soldTime` (string): Sold
- `soldTo` (string): No description
- `syncChildItemsLocations` (boolean): No description
- `thumbnailId` (string): No description
- `updatedAt` (string): No description
- `warrantyDetails` (string): No description
- `warrantyExpires` (string): No description
---
**Summary:** Create Item Attachment
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
| `file` | formData | True | file | File attachment |
| `type` | formData | False | string | Type of file |
| `primary` | formData | False | boolean | Is this the primary attachment |
| `name` | formData | True | string | name of the file including extension |
| Name | Type | Description |
|------|------|-------------|
| `file` | file | File attachment |
| `type` | string | Type of file |
| `primary` | boolean | Is this the primary attachment |
| `name` | string | name of the file including extension |
- **200**: OK
**Schema:**
Object with properties:
- `archived` (boolean): No description
- `assetId` (string): No description
- `attachments` (array): No description
- `createdAt` (string): No description
- `description` (string): No description
- `fields` (array): No description
- `id` (string): No description
- `imageId` (string): No description
- `insured` (boolean): No description
- `labels` (array): No description
- `lifetimeWarranty` (boolean): Warranty
- `location` (any): Edges
- `manufacturer` (string): No description
- `modelNumber` (string): No description
- `name` (string): No description
- `notes` (string): Extras
- `parent` (any): No description
- `purchaseFrom` (string): No description
- `purchasePrice` (number): No description
- `purchaseTime` (string): Purchase
- `quantity` (integer): No description
- `serialNumber` (string): No description
- `soldNotes` (string): No description
- `soldPrice` (number): No description
- `soldTime` (string): Sold
- `soldTo` (string): No description
- `syncChildItemsLocations` (boolean): No description
- `thumbnailId` (string): No description
- `updatedAt` (string): No description
- `warrantyDetails` (string): No description
- `warrantyExpires` (string): No description
- **422**: Unprocessable Entity
**Schema:**
Object with properties:
- `error` (string): No description
- `fields` (string): No description
---
**Summary:** Get Item Attachment
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
| `attachment_id` | path | True | string | Attachment ID |
- **200**: OK
**Schema:**
Object with properties:
- `token` (string): No description
---
**Summary:** Update Item Attachment
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
| `attachment_id` | path | True | string | Attachment ID |
| `payload` | body | True | object | Attachment Update |
Object with properties:
- `primary` (boolean): No description
- `title` (string): No description
- `type` (string): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `archived` (boolean): No description
- `assetId` (string): No description
- `attachments` (array): No description
- `createdAt` (string): No description
- `description` (string): No description
- `fields` (array): No description
- `id` (string): No description
- `imageId` (string): No description
- `insured` (boolean): No description
- `labels` (array): No description
- `lifetimeWarranty` (boolean): Warranty
- `location` (any): Edges
- `manufacturer` (string): No description
- `modelNumber` (string): No description
- `name` (string): No description
- `notes` (string): Extras
- `parent` (any): No description
- `purchaseFrom` (string): No description
- `purchasePrice` (number): No description
- `purchaseTime` (string): Purchase
- `quantity` (integer): No description
- `serialNumber` (string): No description
- `soldNotes` (string): No description
- `soldPrice` (number): No description
- `soldTime` (string): Sold
- `soldTo` (string): No description
- `syncChildItemsLocations` (boolean): No description
- `thumbnailId` (string): No description
- `updatedAt` (string): No description
- `warrantyDetails` (string): No description
- `warrantyExpires` (string): No description
---
**Summary:** Delete Item Attachment
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
| `attachment_id` | path | True | string | Attachment ID |
- **204**: No Content
---
**Summary:** Duplicate Item
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
| `payload` | body | True | object | Duplicate Options |
Object with properties:
- `copyAttachments` (boolean): No description
- `copyCustomFields` (boolean): No description
- `copyMaintenance` (boolean): No description
- `copyPrefix` (string): No description
```
- **201**: Created
**Schema:**
Object with properties:
- `archived` (boolean): No description
- `assetId` (string): No description
- `attachments` (array): No description
- `createdAt` (string): No description
- `description` (string): No description
- `fields` (array): No description
- `id` (string): No description
- `imageId` (string): No description
- `insured` (boolean): No description
- `labels` (array): No description
- `lifetimeWarranty` (boolean): Warranty
- `location` (any): Edges
- `manufacturer` (string): No description
- `modelNumber` (string): No description
- `name` (string): No description
- `notes` (string): Extras
- `parent` (any): No description
- `purchaseFrom` (string): No description
- `purchasePrice` (number): No description
- `purchaseTime` (string): Purchase
- `quantity` (integer): No description
- `serialNumber` (string): No description
- `soldNotes` (string): No description
- `soldPrice` (number): No description
- `soldTime` (string): Sold
- `soldTo` (string): No description
- `syncChildItemsLocations` (boolean): No description
- `thumbnailId` (string): No description
- `updatedAt` (string): No description
- `warrantyDetails` (string): No description
- `warrantyExpires` (string): No description
---
**Summary:** Get Maintenance Log
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
| `status` | query | False | string | |
- **200**: OK
**Schema:**
Array of:
Object with properties:
- `completedDate` (string): No description
- `cost` (string): No description
- `description` (string): No description
- `id` (string): No description
- `itemID` (string): No description
- `itemName` (string): No description
- `name` (string): No description
- `scheduledDate` (string): No description
---
**Summary:** Create Maintenance Entry
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
| `payload` | body | True | object | Entry Data |
Object with properties:
- `completedDate` (string): No description
- `cost` (string): No description
- `description` (string): No description
- `name` (string): No description
- `scheduledDate` (string): No description
```
- **201**: Created
**Schema:**
Object with properties:
- `completedDate` (string): No description
- `cost` (string): No description
- `description` (string): No description
- `id` (string): No description
- `name` (string): No description
- `scheduledDate` (string): No description
---
**Summary:** Get the full path of an item
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
- **200**: OK
**Schema:**
Array of:
Object with properties:
- `id` (string): No description
- `name` (string): No description
- `type` (any): No description
---
**Summary:** Get Asset label
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Asset ID |
| `print` | query | False | boolean | Print this label, defaults to false |
- **200**: image/png
**Schema:**
string
---
**Summary:** Get Item label
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Item ID |
| `print` | query | False | boolean | Print this label, defaults to false |
- **200**: image/png
**Schema:**
string
---
**Summary:** Get Location label
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Location ID |
| `print` | query | False | boolean | Print this label, defaults to false |
- **200**: image/png
**Schema:**
string
---
**Summary:** Get All Labels
- **200**: OK
**Schema:**
Array of:
Object with properties:
- `color` (string): No description
- `createdAt` (string): No description
- `description` (string): No description
- `id` (string): No description
- `name` (string): No description
- `updatedAt` (string): No description
---
**Summary:** Create Label
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `payload` | body | True | object | Label Data |
Object with properties:
- `color` (string): No description
- `description` (string): No description
- `name` (string): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `color` (string): No description
- `createdAt` (string): No description
- `description` (string): No description
- `id` (string): No description
- `name` (string): No description
- `updatedAt` (string): No description
---
**Summary:** Get Label
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Label ID |
- **200**: OK
**Schema:**
Object with properties:
- `color` (string): No description
- `createdAt` (string): No description
- `description` (string): No description
- `id` (string): No description
- `name` (string): No description
- `updatedAt` (string): No description
---
**Summary:** Update Label
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Label ID |
- **200**: OK
**Schema:**
Object with properties:
- `color` (string): No description
- `createdAt` (string): No description
- `description` (string): No description
- `id` (string): No description
- `name` (string): No description
- `updatedAt` (string): No description
---
**Summary:** Delete Label
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Label ID |
- **204**: No Content
---
**Summary:** Get All Locations
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `filterChildren` | query | False | boolean | Filter locations with parents |
- **200**: OK
**Schema:**
Array of:
Object with properties:
- `createdAt` (string): No description
- `description` (string): No description
- `id` (string): No description
- `itemCount` (integer): No description
- `name` (string): No description
- `updatedAt` (string): No description
---
**Summary:** Create Location
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `payload` | body | True | object | Location Data |
Object with properties:
- `description` (string): No description
- `name` (string): No description
- `parentId` (string): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `createdAt` (string): No description
- `description` (string): No description
- `id` (string): No description
- `name` (string): No description
- `updatedAt` (string): No description
---
**Summary:** Get Locations Tree
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `withItems` | query | False | boolean | include items in response tree |
- **200**: OK
**Schema:**
Array of:
Object with properties:
- `children` (array): No description
- `id` (string): No description
- `name` (string): No description
- `type` (string): No description
---
**Summary:** Get Location
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Location ID |
- **200**: OK
**Schema:**
Object with properties:
- `children` (array): No description
- `createdAt` (string): No description
- `description` (string): No description
- `id` (string): No description
- `name` (string): No description
- `parent` (any): No description
- `totalPrice` (number): No description
- `updatedAt` (string): No description
---
**Summary:** Update Location
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Location ID |
| `payload` | body | True | object | Location Data |
Object with properties:
- `description` (string): No description
- `id` (string): No description
- `name` (string): No description
- `parentId` (string): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `children` (array): No description
- `createdAt` (string): No description
- `description` (string): No description
- `id` (string): No description
- `name` (string): No description
- `parent` (any): No description
- `totalPrice` (number): No description
- `updatedAt` (string): No description
---
**Summary:** Delete Location
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Location ID |
- **204**: No Content
---
**Summary:** Query All Maintenance
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `status` | query | False | string | |
- **200**: OK
**Schema:**
Array of:
Object with properties:
- `completedDate` (string): No description
- `cost` (string): No description
- `description` (string): No description
- `id` (string): No description
- `itemID` (string): No description
- `itemName` (string): No description
- `name` (string): No description
- `scheduledDate` (string): No description
---
**Summary:** Update Maintenance Entry
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Maintenance ID |
| `payload` | body | True | object | Entry Data |
Object with properties:
- `completedDate` (string): No description
- `cost` (string): No description
- `description` (string): No description
- `name` (string): No description
- `scheduledDate` (string): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `completedDate` (string): No description
- `cost` (string): No description
- `description` (string): No description
- `id` (string): No description
- `name` (string): No description
- `scheduledDate` (string): No description
---
**Summary:** Delete Maintenance Entry
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Maintenance ID |
- **204**: No Content
---
**Summary:** Get Notifiers
- **200**: OK
**Schema:**
Array of:
Object with properties:
- `createdAt` (string): No description
- `groupId` (string): No description
- `id` (string): No description
- `isActive` (boolean): No description
- `name` (string): No description
- `updatedAt` (string): No description
- `url` (string): No description
- `userId` (string): No description
---
**Summary:** Create Notifier
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `payload` | body | True | object | Notifier Data |
Object with properties:
- `isActive` (boolean): No description
- `name` (string): No description
- `url` (string): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `createdAt` (string): No description
- `groupId` (string): No description
- `id` (string): No description
- `isActive` (boolean): No description
- `name` (string): No description
- `updatedAt` (string): No description
- `url` (string): No description
- `userId` (string): No description
---
**Summary:** Test Notifier
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `url` | query | True | string | URL |
- **204**: No Content
---
**Summary:** Update Notifier
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Notifier ID |
| `payload` | body | True | object | Notifier Data |
Object with properties:
- `isActive` (boolean): No description
- `name` (string): No description
- `url` (string): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `createdAt` (string): No description
- `groupId` (string): No description
- `id` (string): No description
- `isActive` (boolean): No description
- `name` (string): No description
- `updatedAt` (string): No description
- `url` (string): No description
- `userId` (string): No description
---
**Summary:** Delete a Notifier
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `id` | path | True | string | Notifier ID |
- **204**: No Content
---
**Summary:** Search EAN from Barcode
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `data` | query | False | string | barcode to be searched |
- **200**: OK
**Schema:**
Array of:
Object with properties:
- `barcode` (string): No description
- `imageBase64` (string): No description
- `imageURL` (string): No description
- `item` (any): No description
- `manufacturer` (string): No description
- `modelNumber` (string): Identifications
- `notes` (string): Extras
- `search_engine_name` (string): No description
---
**Summary:** Create QR Code
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `data` | query | False | string | data to be encoded into qrcode |
- **200**: image/jpeg
**Schema:**
string
---
**Summary:** Export Bill of Materials
- **200**: text/csv
**Schema:**
string
---
**Summary:** Application Info
- **200**: OK
**Schema:**
Object with properties:
- `allowRegistration` (boolean): No description
- `build` (any): No description
- `demo` (boolean): No description
- `health` (boolean): No description
- `labelPrinting` (boolean): No description
- `latest` (any): No description
- `message` (string): No description
- `title` (string): No description
- `versions` (array): No description
---
**Summary:** Change Password
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `payload` | body | True | object | Password Payload |
Object with properties:
- `current` (string): No description
- `new` (string): No description
```
- **204**: No Content
---
**Summary:** User Login
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `payload` | body | True | object | Login Data |
| `provider` | query | False | string | auth provider |
Object with properties:
- `password` (string): No description
- `stayLoggedIn` (boolean): No description
- `username` (string): No description
```
- **200**: OK
**Schema:**
Object with properties:
- `attachmentToken` (string): No description
- `expiresAt` (string): No description
- `token` (string): No description
---
**Summary:** User Logout
- **204**: No Content
---
**Summary:** User Token Refresh
**Description:** handleAuthRefresh returns a handler that will issue a new token from an existing token.
This does not validate that the user still exists within the database.
- **200**: OK
---
**Summary:** Register New User
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `payload` | body | True | object | User Data |
Object with properties:
- `email` (string): No description
- `name` (string): No description
- `password` (string): No description
- `token` (string): No description
```
- **204**: No Content
---
**Summary:** Get User Self
- **200**: OK
---
**Summary:** Update Account
| Name | In | Required | Type | Description |
|------|----|----------|------|-------------|
| `payload` | body | True | object | User Data |
Object with properties:
- `email` (string): No description
- `name` (string): No description
```
- **200**: OK
---
**Summary:** Delete Account
- **204**: No Content
---