AccountIntegration#
No description
Address#
A full address.
Fields#
Name | Description |
---|
city (String ) |
The name of the city, district, village, or town. |
country (String ) |
The name of the country. |
postalCode (String ) |
The ZIP Code or postal code. |
state (String ) |
The region of the address. |
street (String ) |
The first line of the address. |
street2 (String ) |
The second line of the address. |
Browser#
The web browser used by the contact.
Fields#
Name | Description |
---|
family (String ) |
The name of the browser. |
version (String ) |
The version of the browser. |
ChannelIntegration#
No description
Company#
A company represents an organization containing one or more contacts.
Fields#
Name | Description |
---|
contacts (ContactConnection ) |
The contacts in the company. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. |
|
conversationCount (Int! ) |
The total number of conversations that the company is involved in. |
createdAt (DateTime! ) |
The date and time that the object was created. |
customFieldValues (CustomFieldValueConnection ) |
Lists all custom fields. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. | filter (CustomFieldValuesFilter )
Filter custom field values. |
|
domain (String ) |
The company's primary domain. |
id (ID! ) |
The URL of the company's logo. |
name (String ) |
The company name. |
updatedAt (DateTime! ) |
The date and time that the object was last updated. |
Interfaces#
Name | Description |
---|
Node |
An object with an ID. |
Timestamped |
An object with timestamp fields for when it was created and last updated. |
CustomFieldValuesField |
A list of custom fields filtered by input. |
CompanyAddContactsPayload#
Autogenerated return type of CompanyAddContacts
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
company (Company! ) |
The updated company. |
errors ([UserError!]! ) |
Errors related to user input. |
CompanyConnection#
The connection type for Company.
Fields#
Name | Description |
---|
edges ([CompanyEdge] ) |
A list of edges. |
nodes ([Company] ) |
A list of nodes. |
pageInfo (PageInfo! ) |
Information to aid in pagination. |
totalCount (Int! ) |
The total number of objects returned from the query. |
totalPageCount (Int! ) |
The total number of pages based on total page count and page size. |
CompanyCreatePayload#
Autogenerated return type of CompanyCreate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
company (Company ) |
The company that was created. |
errors ([UserError!]! ) |
Errors related to user input. |
CompanyDeletePayload#
Autogenerated return type of CompanyDelete
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
deletedCompanyId (ID ) |
The ID of the deleted company. |
errors ([UserError!]! ) |
Errors related to user input. |
CompanyEdge#
An edge in a connection.
Fields#
Name | Description |
---|
cursor (String! ) |
A cursor for use in pagination. |
node (Company ) |
The item at the end of the edge. |
CompanyMergePayload#
Autogenerated return type of CompanyMerge
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
target (Company! ) |
The merged company. |
CompanyRemoveContactsPayload#
Autogenerated return type of CompanyRemoveContacts
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
company (Company! ) |
Errors related to user input. |
Contact#
that role is defined by their participation with a
particular conversation. This means the same contact could be the
customer on one conversation, and a collaborator on another.
Fields#
Name | Description |
---|
avatarUrl (String ) |
The URL of the contact's avatar. |
companies (CompanyConnection ) |
The companies that the contact belongs to. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. |
|
contactType (ContactType! ) |
The type of the contact. |
conversationCount (Int! ) |
The total number of conversations that the contact is involved in. |
createdAt (DateTime! ) |
The date and time that the object was created. |
customFieldValues (CustomFieldValueConnection ) |
Lists all custom fields. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. | filter (CustomFieldValuesFilter )
Filter custom field values. |
|
email (EmailAddress ) |
The contact's primary email address. |
firstName (String ) |
The contact's first name. |
id (ID! ) |
The contact's last name. |
lastSeenAt (DateTime ) |
The date and time that the contact was last seen. |
name (String ) |
The contact's full name. |
role (ContactRole ) |
The contact's role in a conversation. |
secondaryEmails ([EmailAddress!] ) |
The contact's secondary email addresses. |
updatedAt (DateTime! ) |
The date and time that the object was last updated. |
Interfaces#
Name | Description |
---|
Node |
An object with an ID. |
Timestamped |
An object with timestamp fields for when it was created and last updated. |
CustomFieldValuesField |
A list of custom fields filtered by input. |
ContactConnection#
The connection type for Contact.
Fields#
Name | Description |
---|
edges ([ContactEdge] ) |
A list of edges. |
nodes ([Contact] ) |
A list of nodes. |
pageInfo (PageInfo! ) |
Information to aid in pagination. |
totalCount (Int! ) |
The total number of objects returned from the query. |
totalPageCount (Int! ) |
The total number of pages based on total page count and page size. |
ContactCreatePayload#
Autogenerated return type of ContactCreate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
contact (Contact ) |
The contact that was created. |
errors ([UserError!]! ) |
Errors related to user input. |
ContactDeletePayload#
Autogenerated return type of ContactDelete
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
deletedContactId (ID ) |
The ID of the deleted contact. |
errors ([UserError!]! ) |
Errors related to user input. |
ContactEdge#
An edge in a connection.
Fields#
Name | Description |
---|
cursor (String! ) |
A cursor for use in pagination. |
node (Contact ) |
The item at the end of the edge. |
ContactMergePayload#
Autogenerated return type of ContactMerge
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
target (Contact! ) |
The merged contact. |
ContactResyncPayload#
Autogenerated return type of ContactResync
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
contact (Contact! ) |
The updated contact. |
errors ([UserError!]! ) |
Errors related to user input. |
ContactUpdatePayload#
Autogenerated return type of ContactUpdate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
contact (Contact! ) |
The updated contact. |
errors ([UserError!]! ) |
Errors related to user input. |
Credentials#
No description
Fields#
Name | Description |
---|
createdAt (DateTime! ) |
The date and time when the access token was created. |
expiresAt (DateTime ) |
The date and time when the access token expires. |
expiresIn (Int ) |
The number of seconds until the access token expires. |
token (String! ) |
The access token. |
CustomField#
Custom fields provide agents with the ability to define extra data on a
contact or company, along with the means of specifying how that
information is entered and displayed.
Fields#
Name | Description |
---|
category (CustomFieldCategory! ) |
The category the custom field belongs to. |
createdAt (DateTime! ) |
The date and time that the object was created. |
deletable (Boolean! ) |
True if the custom field can be deleted; false otherwise. |
description (String ) |
A description of the custom field. |
handleType (CustomFieldHandleType ) |
The unique identifier type linked to this field. |
hidden (Boolean! ) |
True if the custom field needs to be hidden in the UI; false otherwise. |
icon (CustomFieldIcon! ) |
The icon for the custom field. |
id (ID! ) |
True if the custom field allows arrays of values; false otherwise. |
key (String! ) |
An immutable identifier for the custom field. |
name (String ) |
The name of the custom field. |
options (CustomFieldOptionConnection ) |
The available options for the custom field if the type is. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. |
|
placeholder (String ) |
The text to show in the input field when it is empty. |
position (Int ) |
The position of the custom field within the category. The first item starts at 1. Leave blank to append the custom field to the end of the list. |
type (CustomFieldType! ) |
The data type of the custom field. |
updatedAt (DateTime! ) |
The date and time that the object was last updated. |
Interfaces#
Name | Description |
---|
Node |
An object with an ID. |
Timestamped |
An object with timestamp fields for when it was created and last updated. |
CustomFieldCategory#
A grouping of contact or company fields.
Fields#
Name | Description |
---|
createdAt (DateTime! ) |
The date and time that the object was created. |
customFields (CustomFieldConnection! ) |
The custom fields belonging to the custom field category. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. |
|
deletable (Boolean! ) |
True if the custom field category can be deleted; false otherwise. |
id (ID! ) |
An immutable identifier for the custom field category. |
name (String! ) |
The name of the custom field category. |
type (CustomFieldCategoryType! ) |
The type of the custom field category. |
updatedAt (DateTime! ) |
The date and time that the object was last updated. |
Interfaces#
Name | Description |
---|
Node |
An object with an ID. |
Timestamped |
An object with timestamp fields for when it was created and last updated. |
CustomFieldCategoryConnection#
The connection type for CustomFieldCategory.
Fields#
CustomFieldCategoryCreatePayload#
Autogenerated return type of CustomFieldCategoryCreate
Fields#
Name | Description |
---|
category (CustomFieldCategory ) |
The created custom field category. |
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
CustomFieldCategoryDeletePayload#
Autogenerated return type of CustomFieldCategoryDelete
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
deletedCategoryId (ID ) |
The ID of the deleted custom field category. |
errors ([UserError!]! ) |
Errors related to user input. |
newCategory (CustomFieldCategory ) |
The category that the custom fields were moved to. |
CustomFieldCategoryEdge#
An edge in a connection.
Fields#
CustomFieldCategoryUpdatePayload#
Autogenerated return type of CustomFieldCategoryUpdate
Fields#
Name | Description |
---|
category (CustomFieldCategory ) |
The updated custom field category. |
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
CustomFieldConnection#
The connection type for CustomField.
Fields#
CustomFieldCreatePayload#
Autogenerated return type of CustomFieldCreate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
customField (CustomField ) |
The created custom field. |
errors ([UserError!]! ) |
Errors related to user input. |
CustomFieldDeletePayload#
Autogenerated return type of CustomFieldDelete
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
deletedCustomFieldId (ID ) |
The ID of the deleted custom field. |
errors ([UserError!]! ) |
Errors related to user input. |
CustomFieldEdge#
An edge in a connection.
Fields#
Name | Description |
---|
cursor (String! ) |
A cursor for use in pagination. |
node (CustomField ) |
The item at the end of the edge. |
CustomFieldOption#
An option for a custom field of type DROPDOWN
.
Fields#
Name | Description |
---|
customField (CustomField! ) |
The custom field associated with the list. |
label (String! ) |
The label of the dropdown option. |
value (String! ) |
The value of the dropdown option. |
CustomFieldOptionConnection#
The connection type for CustomFieldOption.
Fields#
CustomFieldOptionDeletePayload#
Autogenerated return type of CustomFieldOptionDelete
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
deletedCustomFieldOptionId (ID ) |
The ID of the deleted custom field option. |
errors ([UserError!]! ) |
Errors related to user input. |
CustomFieldOptionEdge#
An edge in a connection.
Fields#
Name | Description |
---|
cursor (String! ) |
A cursor for use in pagination. |
node (CustomFieldOption ) |
The item at the end of the edge. |
CustomFieldRemovePayload#
Autogenerated return type of CustomFieldRemove
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
item (CustomFieldSubjectType! ) |
The updated contact or company. |
removedItemId (ID! ) |
The ID of the removed custom field. |
customFieldRestorePayload#
Autogenerated return type of customFieldRestore
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
customField (CustomField! ) |
The custom field that was restored. |
errors ([UserError!]! ) |
Errors related to user input. |
CustomFieldUpdatePayload#
Autogenerated return type of CustomFieldUpdate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
customField (CustomField! ) |
The updated custom field. |
errors ([UserError!]! ) |
Errors related to user input. |
CustomFieldValue#
The value of a contact or company custom field.
Fields#
Name | Description |
---|
customField (CustomField! ) |
The custom field. |
id (ID! ) |
The value assigned to the custom field. |
CustomFieldValueConnection#
The connection type for CustomFieldValue.
Fields#
CustomFieldValueEdge#
An edge in a connection.
Fields#
Name | Description |
---|
cursor (String! ) |
A cursor for use in pagination. |
node (CustomFieldValue ) |
The item at the end of the edge. |
CustomFieldValuesBulkUpdatePayload#
Autogenerated return type of CustomFieldValuesBulkUpdate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
CustomFieldValuesUpdatePayload#
Autogenerated return type of CustomFieldValuesUpdate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
subject (CustomFieldSubjectType! ) |
The company or contact the custom field values where set on. |
Device#
The device used by the contact.
Fields#
Name | Description |
---|
family (String ) |
The name of the device. |
EmailMarketingIntegration#
No description
Fields#
Name | Description |
---|
id (ID! ) |
The lists available for this integration. |
| Arguments |
---|
contactId (ID )
Filter out lists that the contact is already subscribed to. |
|
type (EmailMarketingIntegrationType! ) |
The email marketing integration type. |
EmailMarketingIntegrationConnection#
The connection type for EmailMarketingIntegration.
Fields#
EmailMarketingIntegrationEdge#
An edge in a connection.
Fields#
EmailMarketingList#
No description
Fields#
Name | Description |
---|
id (String! ) |
The ID of the email marketing list. |
name (String! ) |
The name of the email marketing list. |
EmailMarketingSubscription#
No description
Fields#
Name | Description |
---|
externalUrl (String ) |
The external url of the email marketing subscription. |
id (String! ) |
The ID of the email marketing subscription. |
listId (String! ) |
The ID of the email marketing list. |
listName (String! ) |
The name of the email marketing list. |
subscribedAt (DateTime ) |
The date and time that the contact subscribed to the list. |
EmailMarketingSubscriptionConnection#
The connection type for EmailMarketingSubscription.
Fields#
EmailMarketingSubscriptionCreatePayload#
Autogenerated return type of EmailMarketingSubscriptionCreate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
EmailMarketingSubscriptionDeletePayload#
Autogenerated return type of EmailMarketingSubscriptionDelete
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
EmailMarketingSubscriptionEdge#
An edge in a connection.
Fields#
EventGroupType#
A group of events associated with a conversation.
Fields#
Name | Description |
---|
actor (Actor! ) |
The person or thing that triggered the action. |
changesetId (String! ) |
A unique identifier for this event group, used for deep linking and message sharing. |
collapsed (Boolean! ) |
True if the event group is collapsed; false otherwise. |
fromMerge (Boolean! ) |
True if the event group comes from a merged conversation; false otherwise. |
hasAttachments (Boolean! ) |
True if the event group contains attachments; false otherwise. |
id (ID! ) |
True if the event group is a forward; false otherwise. |
isNote (Boolean! ) |
True if the event group is a note; false otherwise. |
EventGroupTypeConnection#
The connection type for EventGroupType.
Fields#
EventGroupTypeEdge#
An edge in a connection.
Fields#
Name | Description |
---|
cursor (String! ) |
A cursor for use in pagination. |
node (EventGroupType ) |
The item at the end of the edge. |
EventsShopifyCreatePayload#
Autogenerated return type of EventsShopifyCreate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
ExcludedDomain#
A domain that is excluded from being automatically created as a company.
To fetch all excluded domains:
Fields#
Name | Description |
---|
domain (String! ) |
The excluded domain. |
ExcludedDomainConnection#
The connection type for ExcludedDomain.
Fields#
ExcludedDomainCreatePayload#
Autogenerated return type of ExcludedDomainCreate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
excludedDomain (ExcludedDomain ) |
The created excluded domain. |
ExcludedDomainDeletePayload#
Autogenerated return type of ExcludedDomainDelete
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
deletedExcludedDomainId (ID ) |
The ID of the deleted excluded domain. |
errors ([UserError!]! ) |
Errors related to user input. |
ExcludedDomainEdge#
An edge in a connection.
Fields#
Name | Description |
---|
cursor (String! ) |
A cursor for use in pagination. |
node (ExcludedDomain ) |
The item at the end of the edge. |
ExcludedDomainUpdatePayload#
Autogenerated return type of ExcludedDomainUpdate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
excludedDomain (ExcludedDomain ) |
The updated excluded domain. |
File#
A file attached to a contact or company.
Fields#
IntegrationDeleteByProviderPayload#
Autogenerated return type of IntegrationDeleteByProvider
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
deletedIntegrationIds ([ID!] ) |
The IDs of the integrations that were deleted. |
errors ([UserError!]! ) |
Errors related to user input. |
IntegrationDeletePayload#
Autogenerated return type of IntegrationDelete
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
deletedIntegrationId (ID ) |
The ID of the integration that was deleted. |
errors ([UserError!]! ) |
Errors related to user input. |
IntegrationJiraServerCreatePayload#
Autogenerated return type of IntegrationJiraServerCreate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
integration (JiraServerIntegration ) |
The jira server integration that was created. |
IntegrationProviderSettingsUpdatePayload#
Autogenerated return type of IntegrationProviderSettingsUpdate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
IntegrationSettingsUpdatePayload#
Autogenerated return type of IntegrationSettingsUpdate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
integration (IntegrationUnion! ) |
The integration that was updated. |
IntegrationUnionConnection#
The connection type for IntegrationUnion.
Fields#
IntegrationUnionEdge#
An edge in a connection.
Fields#
Name | Description |
---|
cursor (String! ) |
A cursor for use in pagination. |
node (IntegrationUnion ) |
The item at the end of the edge. |
IpAddress#
An IP address.
Fields#
Name | Description |
---|
accuracy (Float ) |
The accuracy of the IP address geolocation. |
address (String! ) |
The IP address. |
city (String ) |
The city of the IP address geolocation. |
country (String ) |
The country of the IP address geolocation. |
domain (String ) |
The domain name of the ISP. |
isp (String ) |
The ISP associated with the IP address. |
latitude (Float ) |
The latitude of the IP address geolocation. |
longitude (Float ) |
The longitude of the IP address geolocation. |
organization (String ) |
The organization associated with the IP address. |
postalCode (String ) |
The postal code of the IP address geolocation. |
subdivisions (String ) |
The time zone of the IP address geolocation. |
JiraServerIntegration#
No description
Fields#
Link#
A text link.
Fields#
Name | Description |
---|
link (String! ) |
The URL of the link. |
text (String ) |
The displayed text of the link. |
LoginPayload#
Autogenerated return type of Login
Fields#
Name | Description |
---|
authState (AuthState! ) |
A unique identifier for the client performing the mutation. |
credentials (Credentials ) |
Errors related to user input. |
MobileNotificationPreferencesUpsertPayload#
Autogenerated return type of MobileNotificationPreferencesUpsert
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
Money#
A amount with the linked defined currency.
Fields#
Name | Description |
---|
amount (Float! ) |
The amount. |
currencyCode (String ) |
The ISO currency code. |
PageInfo#
Information about pagination in a connection.
Fields#
Name | Description |
---|
endCursor (String ) |
When paginating forwards, the cursor to continue. |
hasNextPage (Boolean! ) |
When paginating forwards, are there more items. |
hasPreviousPage (Boolean! ) |
When paginating backwards, are there more items. |
startCursor (String ) |
When paginating backwards, the cursor to continue. |
PageView#
An instance of a page being loaded in browser by a visitor.
Fields#
Name | Description |
---|
id (String ) |
A unique identifier for the page view. |
ipAddress (IpAddress ) |
The IP address of the visitor. |
language (String ) |
The browser language set by the visitor. |
occurredAt (String ) |
The date and time that the page view took place. |
referrer (ReferrerUrl ) |
The page view referrer. |
timeOnPage (Float ) |
The total time spent on the page by the visitor. |
title (String ) |
The title of the page being loaded. |
url (UrlStruct! ) |
The URL of the page being loaded. |
userAgent (UserAgent ) |
The visitor's user agent. |
Platform#
No description
PushTokenClearNotificationCountPayload#
Autogenerated return type of PushTokenClearNotificationCount
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
PushTokenCreatePayload#
Autogenerated return type of PushTokenCreate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
QueryRoot#
The schema's entry-point for queries. This acts as the public, top-level
API from which all queries must start.
CHANGELOG
2020-01
- [NEW]
mailboxes
now accessible via channels
Fields#
Name | Description |
---|
companies (CompanyConnection ) |
Lists all companies. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. | filter (CompanyFilter )
The fields by which to filter the results. | orderBy (CompanyOrder )
The field and direction by which to order the results. |
|
contacts (ContactConnection ) |
Lists all contacts. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. | filter (ContactFilter )
The fields by which to filter the results. | orderBy (ContactOrder )
The field and direction by which to order the results. |
|
customFieldCategories (CustomFieldCategoryConnection ) |
Lists all custom field categories. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. | filter (CustomFieldCategoryFilter )
The fields by which to filter the results. |
|
customFields (CustomFieldConnection ) |
Lists all custom fields. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. | filter (CustomFieldFilter )
The fields by which to filter the results. |
|
customProfile (JSON ) |
Fetches the custom profile for a contact. |
| Arguments |
---|
contactId (ID! )
The ID of the contact. | hardRefresh (Boolean )
Whether the custom profile should be refreshed. | channelId (ID )
The ID of the channel. |
|
emailMarketingIntegrations (EmailMarketingIntegrationConnection! ) |
The installed email marketing integrations. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. |
|
emailMarketingSubscriptions (EmailMarketingSubscriptionConnection! ) |
The email marketing. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. | integrationId (ID! )
The ID of the email marketing integration. | contactId (ID! )
The ID of the contact. |
|
eventGroups (EventGroupTypeConnection! ) |
Returns the elements in the list that come after the specified cursor. |
| Arguments |
---|
before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. | filter (EventGroupsFilterInput! )
The fields by which to filter the results. |
|
excludedDomains (ExcludedDomainConnection ) |
Lists all excluded domains. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. |
|
existsForAnyAccount (Boolean! ) |
Checks if there is already existing OauthCredential with provided shop domain for any Groove account. |
| Arguments |
---|
provider (String! )
The provider to check for existing integrations for. | shopDomain (String! )
The shop domain. |
|
integrations (IntegrationUnionConnection! ) |
Connected integrations. |
| Arguments |
---|
after (String )
Returns the elements in the list that come after the specified cursor. | before (String )
Returns the elements in the list that come before the specified cursor. | first (Int )
Returns the first n elements from the list. | last (Int )
Returns the last n elements from the list. | filter (IntegrationsFilter )
Filter integrations. |
|
node (Node ) |
Fetches an object given its ID. |
| Arguments |
---|
id (ID! )
ID of the object. |
|
nodes ([Node]! ) |
Fetches a list of objects given a list of IDs. |
| Arguments |
---|
ids ([ID!]! )
IDs of the objects. |
|
ping (String! ) |
Performs a health check for the Groove GraphQL API. |
Interfaces#
RechargeIntegration#
No description
Fields#
Name | Description |
---|
fullStoreDomain (String! ) |
The full store domain. |
storeDomain (String! ) |
The shop domain. |
storeName (String! ) |
The shop name. |
ReferrerUrl#
The address of the webpage from which the visitor came to your page.
Fields#
Name | Description |
---|
domain (String ) |
The domain of the URL. |
hash (String ) |
The URL's hash property. |
medium (String ) |
The category of the source. |
path (String ) |
The path of the URL. |
protocol (String ) |
The URL's protocol. |
query (String ) |
The query string of the URL. |
raw (String! ) |
The raw URL. |
searchTerm (String ) |
The search term used by the visitor. |
source (String ) |
The origin of the visitor. |
SalesforceIntegration#
No description
Fields#
Name | Description |
---|
salesforceDomain (String! ) |
The domain of the salesforce installation. |
Session#
A contact visit session as recorded by the Widget.
Fields#
Name | Description |
---|
firstPageView (PageView ) |
The first page view. |
id (String ) |
The session ID. |
lastPageView (PageView ) |
The last page view. |
penultimatePageView (PageView ) |
The second-to-last page view. |
totalPageViews (Int ) |
The total number of page views. |
totalTimeOnPage (Float ) |
The total time spent on page. |
ShopifyIntegration#
No description
Fields#
Name | Description |
---|
storeDomain (String! ) |
The shop domain. |
storeName (String ) |
The shop name. |
ShopifyV2Integration#
No description
Fields#
Name | Description |
---|
storeDomain (String! ) |
The shop domain. |
storeName (String! ) |
The shop name. |
Text#
A text string.
It can represent either a single line, multiple lines, or an email.
Fields#
Name | Description |
---|
content (String! ) |
The text content. |
UploadPayloadField#
No description
UploadPayloadGeneratePayload#
Autogenerated return type of UploadPayloadGenerate
Fields#
Name | Description |
---|
clientMutationId (String ) |
A unique identifier for the client performing the mutation. |
errors ([UserError!]! ) |
Errors related to user input. |
UploadPayloadRequest#
No description
UrlStruct#
A URL.
Fields#
Name | Description |
---|
domain (String ) |
The domain of the URL. |
hash (String ) |
The URL's hash property. |
path (String ) |
The path of the URL. |
protocol (String ) |
The URL's protocol. |
query (String ) |
The query string of the URL. |
raw (String! ) |
The raw URL. |
UserAgent#
A characteristic string used to identify visitors.
Fields#
Name | Description |
---|
browser (Browser ) |
The browser used by the visitor. |
device (Device ) |
The device used by the visitor. |
platform (Platform ) |
The native platform the browser is running on. |
raw (String! ) |
The raw user agent. |
UserError#
A user-readable error
Fields#
Name | Description |
---|
message (String! ) |
A description of the error. |
path ([String!] ) |
The input value where the error came from. |
type (String ) |
A name that can be used to identify the error type. |
UserIntegration#
No description