Docs

Get Resource

GET /resources/{resourceId}

GET/resources/{resourceId}

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 one org resource with its attribute values, rate card links and rule sets.

Requires ResourceInventory.Read permission.

Path Parameters

FieldTypeRequiredDescription
resourceIdGuidRequiredThe org resource.

Response Fields

FieldTypeDescription
id / type / resourceTypeId / resourceVariantIdAs on **Get Resources**.
name / label / identifier / quantity / crewId / settlement / isArchivedAs on **Get Resources**.
attributeValuesarray`{ id, resourceAttributeId, value }`.
rateCardsarray`{ rateCardId, isDefault }`.
ruleSetIdsGuid[]Rule sets linked to the resource.
incompleteobject| null`{ missingRequired: [{ resourceAttributeId, label, pricingRole }], blocksPricing }`. Null when every required attribute has a value.

Error Codes

HTTP StatusDescription
404Resource not found.