Docs

Get Variants

GET /resourceTypes/{resourceTypeId}/variants

GET/resourceTypes/{resourceTypeId}/variants

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Organization tokenx-Organization-TokenOptionalRun **Authorize Organization** in the Authorization folder.

Returns the type's live variants, including the hidden base variant.

Requires ResourceTypeDatabase.Read permission.

Path Parameters

FieldTypeRequiredDescription
resourceTypeIdGuidRequiredThe resource type.

Response Fields

FieldTypeDescription
idGuidThe variant.
resourceTypeIdGuidThe owning type.
namestringVariant name.
isBaseboolThe type's hidden base variant.
rateCardIdGuid| nullThe variant's own card, if any.
valuesarray`{ resourceAttributeId, value }`: the variant's axis values.
componentTargetsarrayA composite variant's repoints: `{ resourceComponentId, targetResourceTypeId, targetResourceTypeName, targetResourceVariantIds[], targetResourceVariantNames[], quantity, isExcluded }`. A component with no entry uses its own target.
associatedRateCardsarray`{ rateCardId, name, isDefault }`: the cards linked to the variant (**Variant Rate Cards**).