/products/{id}Read operationGet a product
Use this operation to get a product. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request. Finance-protected fields are omitted or rejected unless the credential also has the documented finance scope.
products:readPrepare this request
The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.
Path parameters
1idrequiredStable identifier of the resource in the authenticated workspace.
Responses
7200The request to get a product succeeded. The response contains the canonical public result and request metadata.application/json
application/jsonProduct catalog entry. purchasePrice is finance-gated.
The attributes associated with this product.
amountrequiredThe amount associated with this product attributes.
annotationrequiredThe annotation associated with this product attributes.
archivedrequiredWhether this resource is archived.
costCenterrequiredThe cost center associated with this product attributes.
createdAtrequiredTimestamp at which the resource was created.
descriptionrequiredHuman-readable description of the resource.
disabledrequiredWhether this resource is disabled for new use.
financeAccountrequiredThe finance account associated with this product attributes.
namerequiredHuman-readable name of the resource.
priceGroupIdsrequiredOrdered set of price group identifiers associated with this product attributes.
productGroupIdrequiredIdentifier of the product group that contains this product.
productNumberrequiredThe product number associated with this product attributes.
purchasePriceInternal acquisition cost. Present only with products:finance:read.
retailPricerequiredThe retail price associated with this product attributes.
taxRaterequiredThe tax rate associated with this product attributes.
unitrequiredThe unit associated with this product attributes.
updatedAtrequiredTimestamp of the most recent successful update.
idrequiredStable TeamGrid identifier for this resource.
typerequiredCanonical type discriminator for this resource.
Public API representation of meta.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
400The request is invalid.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
401The bearer credential is missing, invalid, expired, or revoked.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
403The credential has insufficient scope.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
404The tenant-scoped resource does not exist.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
429The credential or source exceeded its rate limit.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
503A required cell-local dependency is unavailable.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
Thank you. The rating contains no account or customer data.