Get a product

GET

/products/{id}

const url = 'https://example.com/api/v1/products/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/products/example

Fetches a product by its name or its uuid. Either form resolves, so omniglass product get acme-soundbar and the uuid are interchangeable. Gated by product:read.

Parameters

Path Parameters

required

The product id

string

The product id

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

component_type

required

The component_type this product is classified under (mic, camera, …); the taxonomy above product

string

component_type_id

required

The component_type’s uuid; the stable form of component_type

string

driver

The driver’s handle

string

driver_id

The driver’s uuid; the stable form of driver

string

icon

A product-level icon override; unset inherits the component_type’s icon

string

required

The product’s uuid, the stable handle that survives a rename

string

kind

required

string

Allowed values: device app service

label

required

string

label_rule

The label template instances of this product get, the most specific tier; unset falls back to the component_type chain, then the global component rule

string

name

required

The name an operator reads and types; renameable

string

official

required

boolean

parent_product

The parent product’s handle

string

parent_product_id

The parent product’s uuid; the stable form of parent_product

string

vendor

The vendor’s handle

string

vendor_id

The vendor’s uuid; the stable form of vendor

string

Example

{
  "$schema": "/api/v1/schemas/ProductBody.json",
  "kind": "device"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}