Skip to main content

ContactStoreNoteType

Defines the type for a note within the scope of a contact store.

type ContactStoreNoteType {
  containsPersonalData: Boolean!
  createdAt: DateTime!
  createdBy: String
  id: ID!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  name: String!
  notes(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [ContactStoreNote!]! @deprecated
  notesPaged(
    filterInput: NoteAdvancedSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): ContactStoreNotePage!
  uniqueCode: String
}

Fields​

ContactStoreNoteType.containsPersonalData ● Boolean! non-null scalar​

A flag indicating whether the note type includes sensitive personal data. This is used by EventsAir to identify these fields for reporting to attendees, and when anonymizing or deleting a contact record for data privacy reasons.

ContactStoreNoteType.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

ContactStoreNoteType.createdBy ● String scalar​

UTF-8 string value that represents the username of the user who created the record. Optional.

ContactStoreNoteType.id ● ID! non-null scalar​

The unique identifier for the note type.

ContactStoreNoteType.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

ContactStoreNoteType.lastModifiedBy ● String scalar​

UTF-8 string value that represents the username of the user who last modified the record. Optional.

ContactStoreNoteType.name ● String! non-null scalar​

A UTF-8 string representing the name of the note type.

ContactStoreNoteType.notes ● [ContactStoreNote!]! deprecated non-null object​

DEPRECATED

Use notesPaged instead. It returns the same notes together with pagination metadata (total count, has-next-page) and exposes a richer filter input supporting both inclusion and exclusion semantics (eq, ne, in, notIn). This field will be removed in a future release.

A list of notes for this note type.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
ContactStoreNoteType.notes.limit ● PaginationLimit! non-null scalar​
ContactStoreNoteType.notes.offset ● NonNegativeInt! non-null scalar​

ContactStoreNoteType.notesPaged ● ContactStoreNotePage! non-null object​

Notes for this note type that match the filter criteria specified in the optional filterInput argument, returned together with pagination metadata.

Returns a ContactStoreNotePage wrapper exposing the matched items alongside pageInfo (total count, has-next-page, has-previous-page).

See NoteAdvancedSearchFilterInput for details on how the filterInput argument can be used. The filter supports both inclusion and exclusion semantics (eq, ne, in, notIn) — for example, "all notes whose id is not in a specific list."

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).

Throws an error with code: BAD_USER_INPUT if all fields in the filterInput argument have a combined total number of values exceeding 1,000.

ContactStoreNoteType.notesPaged.filterInput ● NoteAdvancedSearchFilterInput! non-null input​
ContactStoreNoteType.notesPaged.limit ● PaginationLimit! non-null scalar​
ContactStoreNoteType.notesPaged.offset ● NonNegativeInt! non-null scalar​

ContactStoreNoteType.uniqueCode ● String scalar​

A customer supplied, UTF-8 string value that represents a unique code for the note type. Optional.

The value must be unique across all note types for an event.

Member Of​

ContactStoreNote object ● ContactStoreNoteSetup object ● ContactStoreNoteTypePage object ● CreateContactStoreNoteTypePayload object ● UpdateContactStoreNoteTypePayload object