Skip to main content

customRecord

Retrieves one custom record by collection + key.

Business Rules​

  • Records are tenant-scoped to the current company
  • Optionally filter by brand scope
  • Archived records are excluded by default

Permissions Required​

  • tools:read_record
customRecord(
  brandId: ID
  collection: String!
  includeArchived: Boolean
  key: String!
): CustomRecord

Arguments​

customRecord.brandId ● ID scalar common​

Optional brand scope for the record.

customRecord.collection ● String! non-null scalar common​

Collection name that owns the record.

customRecord.includeArchived ● Boolean scalar common​

Set true to include archived records in lookup.

customRecord.key ● String! non-null scalar common​

Stable key within the collection.

Type​

CustomRecord object common​

A tenant-scoped custom JSON record identified by collection + key. Records are persisted in the Tools store and can optionally be scoped to a brand through metadata.