Docs

Get Resource Attributes

GET /resource-attributes?includeArchived=false

GET/resource-attributes?includeArchived=false

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually.

Returns the event's resource attribute library: the reusable field definitions that resource types place into their sections. Ordered by name.

Event scoping: This endpoint does not include {eventId} in the URL. The event is determined automatically from your x-Event-Token.

Query Parameters

FieldTypeRequiredDescription
includeArchivedboolOptionalInclude archived attributes. Default `false`.

Response Fields

FieldTypeDescription
idGuidThe attribute.
namestringDisplay label.
responseTypestringOne of `Select`, `MultiSelect`, `Text`, `RichText`, `Number`, `Date`, `DateTime`, `Checkbox`, `Link`, `File`, `MultiFile`.
isArchivedboolArchived attributes can't be placed until restored.
optionsarray`{ id, label, type, value }`. Select and MultiSelect only. A stored value is the option `id`.
usedByTypeCountintHow many resource types place the attribute.
valueCountintHow many records hold a value for it. Resources plus needs.
willArchiveboolWhat **Delete Resource Attribute** will do: `true` archives, `false` deletes. True when anything references it: values, modifiers, live variants pinning one of its options, or event advance data. Computed by the same check the delete runs.
orgCorrelationIdGuid| nullSet when the attribute was pulled from the org library.