Docs
Get Resource Attributes
GET /resource-attributes?includeArchived=false
GET
/resource-attributes?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. |
Returns the organization's resource attribute library: the reusable field definitions that resource types place into their sections. Ordered by name.
Requires
ResourceTypeDatabase.Read permission.Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| includeArchived | bool | Optional | Include archived attributes. Default `false`. |
Response Fields
| Field | Type | Description |
|---|---|---|
| id | Guid | The attribute. |
| name | string | Display label. |
| responseType | string | One of `Select`, `MultiSelect`, `Text`, `RichText`, `Number`, `Date`, `DateTime`, `Checkbox`, `Link`, `File`, `MultiFile`. |
| isArchived | bool | Archived attributes can't be placed until restored. |
| options | array | `{ id, label, type, value }`. Select and MultiSelect only. A stored value is the option `id`. |
| usedByTypeCount | int | How many resource types place the attribute. |
| valueCount | int | How many records hold a value for it. |
| willArchive | bool | What **Delete Resource Attribute** will do: `true` archives, `false` deletes. True when anything references it: values, modifiers, or live variants pinning one of its options. Computed by the same check the delete runs. |