Skip to content

Products

Part of the API reference. Authentication, scopes, rate limits and errors are on the overview.

BitHive Reporting Desk API · 0.11.0

Products

GET/v1/products

List the products of the account

Returns the products the token may see: all products of the account, or only the one the token is limited to. Archived products are included and marked.

Scope: products:read

Responses

200 The products the token may see. ProductList

{
  "products": [
    {
      "id": "3f1b0c9e-6a27-4f5b-9c1d-2e8a7b4d5c60",
      "name": "Fleet Service",
      "created_at": "2026-08-03T09:12:44Z",
      "archived": false
    },
    {
      "id": "8c2d4e6a-15b3-4a7c-8e90-1d2f3a4b5c6d",
      "name": "Device Bridge",
      "created_at": "2026-08-19T14:05:02Z",
      "archived": false
    }
  ]
}

Example

curl --fail-with-body -sS \
  -H "Authorization: Bearer $BITHIVE_TOKEN" \
  "https://app.bithive-it.com/v1/products"

GET/v1/products/{productId}

Read one product

Returns the product. A product of another account, and a product the token is not limited to, are reported as not found.

Scope: products:read

Parameters

ParameterInTypeDescription
productId requiredpathstring (uuid)Identifier of the product.

Responses

200 The product. Product

{
  "id": "3f1b0c9e-6a27-4f5b-9c1d-2e8a7b4d5c60",
  "name": "Fleet Service",
  "created_at": "2026-08-03T09:12:44Z",
  "archived": false
}

Example

curl --fail-with-body -sS \
  -H "Authorization: Bearer $BITHIVE_TOKEN" \
  "https://app.bithive-it.com/v1/products/$PRODUCTID"

The contract itself. This page is built from the OpenAPI document of the service. It is published as a file, so a client generator can read the same contract this page describes. Download openapi.yaml

Docs

Start free 14-day trial