Docs
Get Resources
GET /resources?type=Asset&resourceTypeId={resourceTypeId}&includeArchived=false
GET
/resources?type=Asset&resourceTypeId={resourceTypeId}&includeArchived=falseRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Organization token | x-Organization-Token | Optional | Run **Authorize Organization** in the Authorization folder. |
Lists org inventory resources.
Requires
ResourceInventory.Read permission.Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| type | string | Optional | `Asset` or `Crew`. |
| resourceTypeId | Guid | Optional | Filter to one type. |
| variantId | Guid | Optional | Filter to one variant. |
| includeArchived | bool | Optional | Include archived resources. |
Response Fields
| Field | Type | Description |
|---|---|---|
| id | Guid | The resource. |
| type | string | `Asset` or `Crew`. |
| resourceTypeId | Guid | Its type. |
| resourceVariantId | Guid | Its variant. |
| name / label / identifier | string | Display fields. |
| quantity | int| null | Pooled and Expendable stock. |
| crewId | Guid| null | Set for Crew. |
| settlement | string | `OwnedCost` or `Invoiceable`. |
| defaultRateCardId | Guid| null | The resource's default card. |
| isArchived | bool | Archived. |
| attributeValues | array | `{ resourceAttributeId, value }`. |
| incomplete | object| null | `{ missingRequired: [{ resourceAttributeId, label, pricingRole }], blocksPricing }`. Null when every required attribute has a value. |