Docs
Get Resources
GET /resources
GET
/resourcesLists the organization's inventory resources. Filter by type (Asset or Crew), resourceTypeId and variantId; archived resources appear only with includeArchived. incomplete lists required attributes still missing and whether that blocks pricing. Use Resources_GetResource for one resource's rate cards and rule sets. Needs the resource inventory read permission.
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| type | string | Optional | |
| resourceTypeId | uuid | Optional | |
| variantId | uuid | Optional | |
| includeArchived | boolean | Optional |
Response
Type: GetResourcesResponse[]
GetResourcesResponse
| Field | Type | Description |
|---|---|---|
| id | uuid | |
| type | string| null | |
| resourceTypeId | uuid | |
| resourceVariantId | uuid | |
| name | string| null | |
| label | string| null | |
| identifier | string| null | |
| quantity | integer| null | |
| crewId | uuid| null | |
| settlement | string| null | |
| defaultRateCardId | uuid| null | |
| isArchived | boolean | |
| attributeValues | GetResourcesResponseAttributeValue[]| null | |
| incomplete | GetResourcesResponseIncompleteInfo |
GetResourcesResponseAttributeValue
| Field | Type | Description |
|---|---|---|
| resourceAttributeId | uuid | |
| value | string| null |
GetResourcesResponseIncompleteInfo
| Field | Type | Description |
|---|---|---|
| missingRequired | GetResourcesResponseIncompleteInfoMissingProperty[]| null | |
| blocksPricing | boolean |
GetResourcesResponseIncompleteInfoMissingProperty
| Field | Type | Description |
|---|---|---|
| resourceAttributeId | uuid | |
| label | string| null | |
| pricingRole | string| null |