Get Product

Retrieve detailed information about a specific product. Use this endpoint to verify product details or retrieve metadata like creation time.

When to Use This Endpoint

Use this endpoint when you have a productId and need to:

Verify the product exists.
Retrieve the product’s full name or metadata.
Debug permissions or access.

Request

Endpoint

GET <BINARLY_API_URL>/api/v4/products/{productId}

Path Parameters

Parameter	Required	Description
`productId`	Yes	The unique identifier of the product (ULID)

Headers

Header	Value
`Authorization`	`Bearer <access_token>`

Example Request

BINARLY_PRODUCT_ID="01JQPGDX8QW0YJ0XEKV1EVG534"

curl -s \
  -H "Authorization: Bearer ${TOKEN}" \
  "${BINARLY_API_URL}/api/v4/products/${BINARLY_PRODUCT_ID}"

Response

{
  "id": "01JQPGDX8QW0YJ0XEKV1EVG534",
  "name": "My Firmware Product",
  "description": "Production firmware for device X",
  "createTime": "2024-01-20T10:00:00Z",
  "author": {
    "id": "01JV49FS1ZSGQ72NN6E0RXK3T0",
    "userId": "01JV49FS1ZSGQ72NN6E0RXK3T0",
    "email": "user@example.com",
    "status": "active"
  }
}

Field	Description
`id`	Product ID (ULID)
`name`	The display name of the product
`description`	Product description, an empty string when not set
`createTime`	Timestamp when the product was created
`author`	User or service that created the product
`author.email`	Email of the user or API client that created the product
`scope`	Present when the product has scope settings. `scope.disabledFindingTypes` lists the finding types turned off for the product.

A product ID that doesn’t exist returns 404 with {"message":"Product not found"}.

Overview

Use Cases

Reference

When to Use This Endpoint

Request

Example Request

Response