Miscellaneous

Query and manage your brewery's miscellaneous ingredient inventory via the Brewgenix REST API.

Get Miscellaneous Item

Returns a single miscellaneous item by its ID.

GET /api/v1/{account}/miscellaneous/{id}

Path Parameters

Parameter	Type	Description
`account`	string	Your brewery account slug (visible in the app URL).
`id`	string	The miscellaneous item UUID.

Authentication

Requires a valid API key passed as a Bearer token. See Authentication.

Example Request

curl "https://app.brewgenix.com/api/v1/my-brewery/miscellaneous/d4e5f6a7-..." \
  -H "Authorization: Bearer bgx_<your-key>"

Example Response

{
  "id": "d4e5f6a7-...",
  "name": "Irish Moss",
  "type": "fining",
  "unit": "tsp",
  "usage": ["boil"],
  "description": "Clarifying agent added in the last 15 minutes of the boil.",
  "created_at": "2025-01-15T10:00:00Z",
  "updated_at": "2025-01-15T10:00:00Z"
}

Error Responses

Status	Description
`401`	Missing or invalid API key.
`404`	Item not found.
`500`	Internal server error.

List Miscellaneous Items

Returns a paginated list of miscellaneous items in your brewery account.

GET /api/v1/{account}/miscellaneous

Path Parameters

Parameter	Type	Description
`account`	string	Your brewery account slug (visible in the app URL).

Query Parameters

Parameter	Type	Default	Description
`page`	integer	`1`	Page number (1-based).
`limit`	integer	`20`	Number of results per page. Maximum `100`.
`q`	string	-	Search query. Filters by name or description.
`type`	string	-	Filter by type: `spice`, `fining`, `water_agent`, `herb`, `flavour`, or `other`.
`usage`	string	-	Filter by usage stage: `mash`, `sparge`, `boil`, `flameout`, `primary`, `secondary`, `bottling`.

Authentication

Requires a valid API key passed as a Bearer token. See Authentication.

Example Request

curl "https://app.brewgenix.com/api/v1/my-brewery/miscellaneous?type=fining" \
  -H "Authorization: Bearer bgx_<your-key>"

Example Response

{
  "data": [
    {
      "id": "d4e5f6a7-...",
      "name": "Irish Moss",
      "type": "fining",
      "unit": "tsp",
      "usage": ["boil"]
    }
  ],
  "count": 1,
  "page": 1,
  "pageSize": 20,
  "pageCount": 1
}

Error Responses

Status	Description
`401`	Missing or invalid API key.
`400`	Invalid query parameters.
`500`	Internal server error.

Create Miscellaneous Item

Creates a new miscellaneous item in your brewery account.

POST /api/v1/{account}/miscellaneous

Path Parameters

Parameter	Type	Description
`account`	string	Your brewery account slug (visible in the app URL).

Authentication

Requires a valid API key passed as a Bearer token. See Authentication.

Request Body

Field	Type	Required	Description
`name`	string	Yes	Ingredient name.
`type`	string	Yes	Type: `spice`, `fining`, `water_agent`, `herb`, `flavour`, or `other`.
`usage`	array of string	Yes	One or more usage stages: `mash`, `sparge`, `boil`, `flameout`, `primary`, `secondary`, `bottling`.
`unit`	string	No	Unit of measurement (e.g. `g`, `tsp`, `ml`).
`description`	string	No	Description or usage notes.

Example Request

curl -X POST "https://app.brewgenix.com/api/v1/my-brewery/miscellaneous" \
  -H "Authorization: Bearer bgx_<your-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Irish Moss",
    "type": "fining",
    "usage": ["boil"],
    "unit": "tsp",
    "description": "Clarifying agent added in the last 15 minutes of the boil."
  }'

Example Response

{
  "id": "d4e5f6a7-...",
  "name": "Irish Moss",
  "type": "fining",
  "unit": "tsp",
  "usage": ["boil"],
  "description": "Clarifying agent added in the last 15 minutes of the boil.",
  "created_at": "2026-02-24T10:00:00Z",
  "updated_at": "2026-02-24T10:00:00Z"
}

Error Responses

Status	Description
`401`	Missing or invalid API key.
`400`	Request body is not valid JSON.
`422`	Validation failed (e.g. missing required field, empty usage array).
`500`	Internal server error.

Update Miscellaneous Item

Updates an existing miscellaneous item. Only the fields provided in the request body are updated (PATCH semantics).

PATCH /api/v1/{account}/miscellaneous/{id}

Path Parameters

Parameter	Type	Description
`account`	string	Your brewery account slug (visible in the app URL).
`id`	string	The miscellaneous item UUID.

Authentication

Requires a valid API key passed as a Bearer token. See Authentication.

Request Body

All fields are optional. Provide only the fields you want to update.

Field	Type	Description
`name`	string	Ingredient name.
`type`	string	Type: `spice`, `fining`, `water_agent`, `herb`, `flavour`, or `other`.
`usage`	array of string	Usage stages (must not be empty if provided): `mash`, `sparge`, `boil`, `flameout`, `primary`, `secondary`, `bottling`.
`unit`	string	Unit of measurement (e.g. `g`, `tsp`, `ml`).
`description`	string	Description or usage notes.

Example Request

curl -X PATCH "https://app.brewgenix.com/api/v1/my-brewery/miscellaneous/d4e5f6a7-..." \
  -H "Authorization: Bearer bgx_<your-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Add at 15 minutes remaining in the boil for best results.",
    "unit": "g"
  }'

Example Response

{
  "id": "d4e5f6a7-...",
  "name": "Irish Moss",
  "type": "fining",
  "unit": "g",
  "usage": ["boil"],
  "description": "Add at 15 minutes remaining in the boil for best results.",
  "updated_at": "2026-02-24T11:00:00Z"
}

Error Responses

Status	Description
`401`	Missing or invalid API key.
`400`	Request body is not valid JSON.
`404`	Miscellaneous item not found.
`422`	Validation failed (e.g. empty usage array, invalid type value).
`500`	Internal server error.

Delete Miscellaneous Item

Soft-deletes a miscellaneous item. The record is marked as deleted and will no longer appear in list or get requests.

DELETE /api/v1/{account}/miscellaneous/{id}

Path Parameters

Parameter	Type	Description
`account`	string	Your brewery account slug (visible in the app URL).
`id`	string	The miscellaneous item UUID.

Authentication

Requires a valid API key passed as a Bearer token. See Authentication.

Example Request

curl -X DELETE "https://app.brewgenix.com/api/v1/my-brewery/miscellaneous/d4e5f6a7-..." \
  -H "Authorization: Bearer bgx_<your-key>"

Response

Returns 204 No Content on success with an empty body.

Error Responses

Status	Description
`401`	Missing or invalid API key.
`500`	Internal server error.