Docs

Get Resources

GET /resources?resourceTypeId={resourceTypeId}&type=Asset&includeArchived=false

GET/resources?resourceTypeId={resourceTypeId}&type=Asset&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.

The event's assignable pool: resources already on this event. The assign picker's first tier; Get Org Pool Resources is the second.

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

Query Parameters

FieldTypeRequiredDescription
resourceTypeIdGuidOptionalFilter to one type.
typestringOptional`Asset` or `Crew`.
includeArchivedboolOptionalInclude archived resources.

Response Fields

FieldTypeDescription
idGuidThe event resource.
typeobject`{ id, name, kind, trackingType }`. `kind` is `Asset` or `Crew`.
resourceVariantIdGuidThe variant it is bound to.
name / label / identifierstringDisplay fields.
quantitydecimal| nullPooled and Expendable stock.
crewIdGuid| nullSet for Crew resources.
rateCardIdGuid| nullThe resource's own card.
settlementstring`OwnedCost` or `Invoiceable`. Authored on the org side; read-only here.
orgCorrelationIdGuid| nullSet when pulled from the org pool.
activeAssignmentCountintAssignments on this event currently holding it.
incompleteobject| null`{ missingRequired: [{ resourceAttributeId, label, pricingRole }], blocksPricing }`. Null when complete.