Skip to main content
GET
Look up a Catalog product by Attribute value

Usage notes

key is an Attribute storage key and value is an exact stored value. The endpoint searches active products and returns the first match. Use this endpoint only when the selected Attribute is unique in your data model. For general filtering or text search, use GET /catalog.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

key
string
required

Attribute storage key. Letters, digits, underscores, and slashes are accepted.

value
string
required

Exact Attribute value to match.

Response

Matching Catalog product.

id
string<uuid>
required
company_id
string<uuid>
required
schema_id
string<uuid>
required
source
enum<string>
required
Available options:
manual,
product_extraction,
shopify
external_id
string | null
required
status
enum<string>
required
Available options:
draft,
active,
archived
attributes
object
required

Values backed by active Shared Attributes from the base schema or attribute_extensions.

attribute_extensions
object[]
required
Maximum array length: 2000
created_at
string<date-time>
required
updated_at
string<date-time>
required
deleted_at
string<date-time> | null
required
relations
object

Hydrated relation values. Present on the single-product GET response.