ContactStore

Represents an EventsAir contact store.

type ContactStore {
  accessRights: AccessRights!
  alias: String!
  associatedEvents(
    input: FindEventsInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [Event!]!
  communicationTags(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CommunicationTag!]!
  contact(
    id: ID!
  ): ContactStoreContact!
  contacts(
    input: ContactStoreContactSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [ContactStoreContact!]! @deprecated
  contactsPaged(
    filterInput: ContactStoreContactAdvancedSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): ContactStoreContactPage!
  country: String
  createdAt: DateTime!
  createdBy: String
  currencies: [Currency!]!
  customFieldDefinitions: ContactStoreScopedCustomFieldDefinitions!
  customFieldTabs: ContactStoreScopedCustomFieldTabs!
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]! @deprecated
  customFieldsPaged(
    filterInput: CustomFieldAdvancedSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): CustomFieldPage!
  defaultCurrency: Currency!
  emailMessagingService: EmailMessagingService
  id: ID!
  invoiceConfiguration: InvoiceConfiguration
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  link(
    id: ID!
  ): Link!
  links: [Link!]!
  logo: Image
  marketingRecord(
    id: ID!
  ): ContactStoreMarketingRecord!
  marketingRecords(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [ContactStoreMarketingRecord!]!
  mergeDocuments(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [MergeDocument!]!
  name: String!
  note(
    id: ID!
  ): ContactStoreNote!
  notes(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [ContactStoreNote!]! @deprecated
  notesPaged(
    filterInput: NoteAdvancedSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): ContactStoreNotePage!
  office: Office!
  onlinePaymentServices: OnlinePaymentServices!
  setup: ContactStoreSetup!
  state: String
  textMessagingService: TextMessagingService
  uniqueCode: String
  userAccessRights: UserAccessRights! @deprecated
}

Fields

ContactStore.accessRights ● AccessRights! non-null object

Indicates which users or API keys in EventsAir can access this contact store.

ContactStore.alias ● String! non-null scalar

A UTF-8 alphanumeric string representing an alias for a contact store. The alias is used as part of the URL for websites.

An alias can only contain lower-case, alphameric and hyphen characters: [a-z0-9-].

ContactStore.associatedEvents ● [Event!]! non-null object

A list of events associated with this contact store.

See FindEventsInput for details on how the input argument can be used to filter events.

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).

ContactStore.associatedEvents.input ● FindEventsInput! non-null input

ContactStore.associatedEvents.limit ● PaginationLimit! non-null scalar

ContactStore.associatedEvents.offset ● NonNegativeInt! non-null scalar

ContactStore.communicationTags ● [CommunicationTag!]! non-null object

A list of communication tags for this contact store.

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).

ContactStore.communicationTags.limit ● PaginationLimit! non-null scalar

ContactStore.communicationTags.offset ● NonNegativeInt! non-null scalar

ContactStore.contact ● ContactStoreContact! non-null object

Retrieves a contact by its identifier. Throws an error with code NOT_FOUND if no contact is found.

ContactStore.contact.id ● ID! non-null scalar

ContactStore.contacts ● [ContactStoreContact!]! deprecated non-null object

DEPRECATED

Use contactsPaged instead. It returns the same contacts 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.

Contacts for this contact store that match the filter criteria specified in the optional input argument.

By default, inactive contacts are not returned. To include inactive contacts in the result set, set input.contactFilter.includeInactive to true.

By default, contacts that were captured as incomplete registrations are not returned. To include them in the result set, set input.contactFilter.includeIncompleteRegistrations to true.

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).

**Note**: the offset argument must be a multiple of the limit argument otherwise an error will be thrown. The following table shows examples of valid and invalid argument value combinations.

limit	offset	Is valid?
100	0	✅ Yes
100	100	✅ Yes
100	120	❌ No
50	100	✅ Yes
50	75	❌ No
250	750	✅ Yes
33	99	✅ Yes
33	100	❌ No

Throws an error with code:

• BAD_USER_INPUT if the offset argument is not a multiple of the limit argument
• BAD_USER_INPUT if all fields in the input have a combined total number of values exceeding 1,000

ContactStore.contacts.input ● ContactStoreContactSearchFilterInput! non-null input

ContactStore.contacts.limit ● PaginationLimit! non-null scalar

ContactStore.contacts.offset ● NonNegativeInt! non-null scalar

ContactStore.contactsPaged ● ContactStoreContactPage! non-null object

Contacts for this contact store that match the filter criteria specified in the optional filterInput argument, returned together with pagination metadata.

See ContactStoreContactAdvancedSearchFilterInput for details on how the filterInput argument can be used. The filter supports both inclusion and exclusion semantics (eq, ne, in, notIn) on the contact identifier.

By default, inactive contacts are not returned. To include inactive contacts in the result set, set filterInput.contactFilter.includeInactive to true.

By default, contacts that were captured as incomplete registrations are not returned. To include them in the result set, set filterInput.contactFilter.includeIncompleteRegistrations to true.

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).

**Note**: the offset argument must be a multiple of the limit argument otherwise an error will be thrown.

Throws an error with code:

• BAD_USER_INPUT if the offset argument is not a multiple of the limit argument.
• BAD_USER_INPUT if all fields in the filterInput argument have a combined total number of values exceeding 1,000.

ContactStore.contactsPaged.filterInput ● ContactStoreContactAdvancedSearchFilterInput! non-null input

ContactStore.contactsPaged.limit ● PaginationLimit! non-null scalar

ContactStore.contactsPaged.offset ● NonNegativeInt! non-null scalar

ContactStore.country ● String scalar

The name of the country for the contact store. For example The United States of America. Optional.

ContactStore.createdAt ● DateTime! non-null scalar

The date and time the record was created.

ContactStore.createdBy ● String scalar

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

ContactStore.currencies ● [Currency!]! non-null object

A list of supported currencies for the contact store.

ContactStore.customFieldDefinitions ● ContactStoreScopedCustomFieldDefinitions! non-null object

A list of custom field definitions associated with this contact store. The provided key identifies which type of object the fields relate too.

ContactStore.customFieldTabs ● ContactStoreScopedCustomFieldTabs! non-null object

A list of custom field tabs associated with the contact store.

ContactStore.customFields ● [CustomField!]! deprecated non-null object

DEPRECATED

Use customFieldsPaged instead. It returns the same custom fields 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 custom field values associated with this contact store.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

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).

ContactStore.customFields.input ● CustomFieldSearchFilterInput! non-null input

ContactStore.customFields.limit ● PaginationLimit! non-null scalar

ContactStore.customFields.offset ● NonNegativeInt! non-null scalar

ContactStore.customFieldsPaged ● CustomFieldPage! non-null object

Custom fields associated with this record that match the filter criteria specified in the optional filterInput argument, returned together with pagination metadata.

See CustomFieldAdvancedSearchFilterInput for details on how the filterInput argument can be used. The filter supports both inclusion and exclusion semantics (eq, ne, in, notIn).

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.

ContactStore.customFieldsPaged.filterInput ● CustomFieldAdvancedSearchFilterInput! non-null input

ContactStore.customFieldsPaged.limit ● PaginationLimit! non-null scalar

ContactStore.customFieldsPaged.offset ● NonNegativeInt! non-null scalar

ContactStore.defaultCurrency ● Currency! non-null object

A default currency for the contact store.

ContactStore.emailMessagingService ● EmailMessagingService object

The external connected service integrated with this contact store for email messaging. Optional.

ContactStore.id ● ID! non-null scalar

The unique identifier for a contact store.

ContactStore.invoiceConfiguration ● InvoiceConfiguration object

Specifies the configuration of invoices for this contact store. Optional.

ContactStore.lastModifiedAt ● DateTime! non-null scalar

The date and time the record was last modified.

ContactStore.lastModifiedBy ● String scalar

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

ContactStore.link ● Link! non-null object

Retrieves a link by its identifier. Throws an error with code NOT_FOUND if no link is found.

ContactStore.link.id ● ID! non-null scalar

ContactStore.links ● [Link!]! non-null object

The list of links for this contact store.

ContactStore.logo ● Image object

The logo for the contact store. Optional.

ContactStore.marketingRecord ● ContactStoreMarketingRecord! non-null object

Retrieves a marketing record by its identifier. Throws an error with code NOT_FOUND if no marketing record is found.

ContactStore.marketingRecord.id ● ID! non-null scalar

ContactStore.marketingRecords ● [ContactStoreMarketingRecord!]! non-null object

The marketing records for this contact store.

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).

ContactStore.marketingRecords.limit ● PaginationLimit! non-null scalar

ContactStore.marketingRecords.offset ● NonNegativeInt! non-null scalar

ContactStore.mergeDocuments ● [MergeDocument!]! non-null object

A list of Merge Documents for this contact store.

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).

ContactStore.mergeDocuments.limit ● PaginationLimit! non-null scalar

ContactStore.mergeDocuments.offset ● NonNegativeInt! non-null scalar

ContactStore.name ● String! non-null scalar

A UTF-8 string representing the name of a contact store.

ContactStore.note ● ContactStoreNote! non-null object

Retrieves a note by its identifier. Throws an error with code NOT_FOUND if no note is found.

ContactStore.note.id ● ID! non-null scalar

ContactStore.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.

The notes for this contact store.

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).

ContactStore.notes.limit ● PaginationLimit! non-null scalar

ContactStore.notes.offset ● NonNegativeInt! non-null scalar

ContactStore.notesPaged ● ContactStoreNotePage! non-null object

Notes for this contact store 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.

ContactStore.notesPaged.filterInput ● NoteAdvancedSearchFilterInput! non-null input

ContactStore.notesPaged.limit ● PaginationLimit! non-null scalar

ContactStore.notesPaged.offset ● NonNegativeInt! non-null scalar

ContactStore.office ● Office! non-null object

The office that manages the contact store.

ContactStore.onlinePaymentServices ● OnlinePaymentServices! non-null object

The external connected services integrated with this contact store for online payment processing.

ContactStore.setup ● ContactStoreSetup! non-null object

The setup for the contact store.

ContactStore.state ● String scalar

The state, territory or province for the contact store. For example New York. Optional.

ContactStore.textMessagingService ● TextMessagingService object

The external connected service integrated with this contact store for text messaging. Optional.

ContactStore.uniqueCode ● String scalar

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

The value must be unique across all contact stores and events for a tenant.

ContactStore.userAccessRights ● UserAccessRights! deprecated non-null object

DEPRECATED

Use accessRights instead. This field will be removed in a future release.

Indicates which users in EventsAir can access this contact store.

Returned By

contactStore query ● contactStores query

Member Of

UpdateContactStorePayload object

Implemented By

ContactDataStore union