Skip to main content

customRecords

Lists custom records by collection.

Business Rules​

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

Permissions Required​

  • tools:read_record
customRecords(
  activeOnly: Boolean
  brandId: ID
  collection: String!
  limit: Int
): [CustomRecord!]!

Arguments​

customRecords.activeOnly ● Boolean scalar common​

Set true to only include non-archived records.

customRecords.brandId ● ID scalar common​

Optional brand scope for records.

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

Collection name to list records from.

customRecords.limit ● Int scalar common​

Maximum number of records to return.

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.