Skip to main content
GET
Get a product builder profile

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

productProfileId
integer
required

ID of the product profile

Response

The product profile

A Product Builder Profile — a reusable configuration that drives a simplified product-create screen and, when referenced from a product create, enforces its constraints (SKU format, required variant preset / distribution group / custom fields) and stamps its fixed defaults.

id
integer

Unique identifier for the profile

name
string

Human-readable profile name (unique among non-deleted profiles)

slug
string | null

Optional URL-friendly identifier (unique among non-deleted profiles). Can be used in place of profile_id when referencing the profile from a product create via profile_slug.

is_active
boolean

Whether the profile is active. Inactive profiles are ignored by enforcement.

config
object | null

The heterogeneous builder specification for a Product Builder Profile. Unknown keys are permitted so the schema can grow without a code change; the keys enforcement and the builder screen actually read are documented below.

created_at
string<date-time> | null
updated_at
string<date-time> | null