Sign in
Products

get/products/{product_product_id}/parameters

Path parameters

product_product_idstring required

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

constraints.hiddenboolean

Filter for: constraints.hidden

lookups: eq, ne

constraints.reconciliationboolean

Filter for: constraints.reconciliation

lookups: eq

constraints.requiredstring

Filter for: constraints.required

lookups: eq, in

constraints.sharedstring

Filter for: constraints.shared

lookups: eq, null, in

constraints.uniqueboolean

Filter for: constraints.unique

lookups: eq, ne

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

namestring

Filter for: name

lookups: eq, ne, like, ilike, in, out

phase'configuration' | 'fulfillment' | 'ordering'

Filter for: phase

lookups: eq, ne, like, ilike, in, out

positioninteger

Filter for: position

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

scope'asset' | 'tier1' | 'tier2' | 'product' | 'item' | 'marketplace' | 'item_marketplace'

Filter for: scope

lookups: eq, ne, like, ilike, in, out

titlestring

Filter for: title

lookups: eq, ne, like, ilike, in, out

ordering: true

type'text' | 'dropdown' | 'password' | 'email' | 'checkbox' | 'subdomain' | 'domain' | 'address' | 'phone' | 'object' | 'url' | 'choice' | 'heading' | 'content'

Filter for: type

lookups: eq, ne, like, ilike, in, out

Response

idstring required
namestring required
titlestring required
descriptionstring nullable
type'text' | 'dropdown' | 'password' | 'email' | 'checkbox' | 'subdomain' | 'domain' | 'address' | 'phone' | 'object' | 'url' | 'choice' | 'heading' | 'content'
scopestring required
phasestring required
hintstring
defaultobject
placeholderstring
positioninteger nullable

Changes

No recorded changes to this endpoint across all 2 revisions of this API.