Queries
#
accountType: Account
Returns account related information.
#
accountPreferencesType: AccountPreferences
List of account preferences.
#
agentPreferencesType: AgentPreferenceConnection
DEPRECATED Please use agent.preferences.Lists all agent preferences.
#
ArgumentsName | Description |
---|---|
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 (AgentPreferencesFilterInput ) | The fields by which to filter the results. |
#
agentsType: AgentConnection
Lists all agents in the organization.
#
ArgumentsName | Description |
---|---|
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 (AgentFilter ) | The fields by which to filter the results. |
orderBy (AgentOrder ) | The field and direction by which to order the results. |
#
aiConversationSuggestionsType: AiSuggestionConnection
No description
#
ArgumentsName | Description |
---|---|
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 (SuggestionFilterInput! ) | The fields by which to filter the results. |
#
articlesType: ArticleConnection
Lists all Knowledge Base articles.
#
ArgumentsName | Description |
---|---|
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 (ArticleFilter ) | The fields by which to filter the results. |
orderBy (ArticleOrder ) | The field and direction by which to order the results. |
#
attachmentsType: ConversationAttachmentConnection
No description
#
ArgumentsName | Description |
---|---|
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 (AttachmentsFilterInput ) | The fields by which to filter the results. |
#
billingType: BillingType
Returns billing related information.
#
cannedRepliesType: CannedReplyConnection
Lists all canned replies.
#
ArgumentsName | Description |
---|---|
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 (CannedReplyFilter ) | The fields by which to filter the results. |
orderBy (CannedReplyOrder ) | The field and direction by which to order the results. |
#
cannedReplyCategoriesType: CannedReplyCategoryConnection
Lists all canned reply categories.
#
ArgumentsName | Description |
---|---|
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. |
orderBy (CategoryOrder ) | The field and direction by which to order the results. |
#
channelsType: ChannelConnection
Lists all channels.
#
ArgumentsName | Description |
---|---|
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 (ChannelFilter ) | The fields by which to filter the results. |
orderBy (ChannelOrder ) | The field and direction by which to order the results. |
#
companiesType: CompanyConnection
Lists all companies.
#
ArgumentsName | Description |
---|---|
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. |
#
contactsType: ContactConnection
Lists all contacts.
#
ArgumentsName | Description |
---|---|
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. |
#
conversationType: Conversation
Finds a conversation by number.
A Groove conversation is a thread of messages (for example emails, chats, or notes) and associated actions or events (for example 'opened', 'snoozed', and 'assigned').
To fetch Messages/Ratings/StateChanges/etc. on a conversation, query the
Events
connection (on the QueryRoot) with the conversation ID.
To fetch all possible fields:
To search conversations matching a specific keyword:
#
ArgumentsName | Description |
---|---|
number (Int! ) | The conversation number. |
#
conversationPreferencesType: ConversationPreferences
Conversation preferences
#
conversationsType: ConversationConnection
Lists all conversations.
#
ArgumentsName | Description |
---|---|
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 (ConversationFilter ) | The fields by which to filter the results. |
orderBy (ConversationOrder ) | The field and direction by which to order the results. |
#
customFieldCategoriesType: CustomFieldCategoryConnection
Lists all custom field categories.
#
ArgumentsName | Description |
---|---|
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. |
#
customFieldsType: CustomFieldConnection
Lists all custom fields.
#
ArgumentsName | Description |
---|---|
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. |
#
customProfileType: JSON
Fetches the custom profile for a contact
#
ArgumentsName | Description |
---|---|
contactId (ID! ) | The ID of the contact. |
hardRefresh (Boolean ) | Whether the custom profile should be refreshed. |
channelId (ID ) | The ID of the channel. |
#
customerRatingSettingsType: CustomerRatingSettingConnection
No description
#
ArgumentsName | Description |
---|---|
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. |
#
draftsType: DraftConnection
Lists drafts associated to requesting user
#
ArgumentsName | Description |
---|---|
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 (DraftFilter ) | The fields by which to filter the results. |
orderBy (DraftOrder ) | The field and direction by which to order the results. |
#
emailMarketingIntegrationsType: EmailMarketingIntegrationConnection
The installed email marketing integrations.
#
ArgumentsName | Description |
---|---|
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. |
#
emailMarketingSubscriptionsType: EmailMarketingSubscriptionConnection
The email marketing
#
ArgumentsName | Description |
---|---|
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. |
#
ephemeralJobResultType: EphemeralJobResult
Find an ephemeral job result by id
#
eventGroupsType: EventGroupTypeConnection
No description
#
ArgumentsName | Description |
---|---|
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 (EventGroupsFilterInput! ) | The fields by which to filter the results. |
#
eventsType: EventConnection
Lists the events for a given conversation.
#
ArgumentsName | Description |
---|---|
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 (EventsFilterInput! ) | The fields by which to filter the results. |
#
excludedDomainsType: ExcludedDomainConnection
Lists all excluded domains.
#
ArgumentsName | Description |
---|---|
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. |
#
existsForAnyAccountType: Boolean
Checks if there is already existing OauthCredential with provided shop domain for any Groove account.
#
ArgumentsName | Description |
---|---|
provider (String! ) | The provider to check for existing integrations for. |
shopDomain (String! ) | The shop domain. |
#
exportsType: ExportConnection
Lists all exports of organization data.
#
ArgumentsName | Description |
---|---|
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 (ExportFilter ) | The fields by which to filter the results. |
orderBy (ExportOrder ) | The field and direction by which to order the results. |
#
featureTemplateCategoriesType: String
Lists all feature templates categories.
#
featureTemplatesType: FeatureTemplates
Lists feature templates.
#
foldersType: FolderConnection
Lists all folders that are accessible to the authenticated agent. Each folder can be associated with one or more mailboxes.
#
ArgumentsName | Description |
---|---|
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 (FolderFilter ) | The fields by which to filter the results. |
orderBy (FolderOrder ) | The field and direction by which to order the results. |
#
import2ImportsType: ImportConnection
Lists all imports.
#
ArgumentsName | Description |
---|---|
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. |
#
import2ToolsType: ToolConnection
Lists all apps provided by Import2 partner.
#
ArgumentsName | Description |
---|---|
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. |
#
integrationsType: IntegrationUnionConnection
Connected integrations.
#
ArgumentsName | Description |
---|---|
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. |
#
knowledgeBasesType: KnowledgeBaseConnection
Lists all Knowledge Bases.
#
ArgumentsName | Description |
---|---|
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. |
#
latestPublicAgentRepliesType: ReplyConnection
The latest replies made by an agent in the last 3 months.
#
ArgumentsName | Description |
---|---|
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. |
agentId (ID ) | The agent ID to filter by. If no value is provided, all active agents will be used. |
limit (Int ) | The number of replies to return. Default 10, max 20. |
#
meType: Agent
Gets the authenticated agent.
An agent is a user on Groove that is part of an organization.
To find all active agents, along with the teams they belong to, ordered by name:
To query for invited agents:
To reverse order the search:
To fetch agents ordered by the most times you assigned them to a conversation:
To fetch a single agent:
#
nodeType: Node
Fetches an object given its ID.
#
ArgumentsName | Description |
---|---|
id (ID! ) | ID of the object. |
#
nodesType: Node
Fetches a list of objects given a list of IDs.
#
ArgumentsName | Description |
---|---|
ids ([ID!]! ) | IDs of the objects. |
#
pingType: String
Performs a health check for the Groove GraphQL API.
#
pinnedSearchesType: PinnedSearchConnection
DEPRECATED This option is deprecated and will be removed in future versions.Lists all folders that are accessible to the authenticated agent. Each folder can be associated with one or more mailboxes.
#
ArgumentsName | Description |
---|---|
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 (PinnedSearchFilter ) | The fields by which to filter the results. |
orderBy (PinnedSearchOrder ) | The field and direction by which to order the results. |
#
pushTokensType: PushTokenConnection
All push tokens for the current user.
#
ArgumentsName | Description |
---|---|
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. |
#
roomsType: RoomConnection
Lists all Live Chat rooms.
#
ArgumentsName | Description |
---|---|
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 (RoomFilter ) | The fields by which to filter the results. |
orderBy (RoomOrder ) | The field and direction by which to order the results. |
#
roomsCountsType: RoomsCountsResult
Lists all Live Chat room counts.
#
ArgumentsName | Description |
---|---|
folderIds ([ID!] ) | The IDs of the folders to get a chat rooms count for. |
channelId (ID ) | The ID of the channel to filter the chat rooms counts by. |
channelType (RoomChannelTypeEnum ) | The channel type that the request needs to be filtered by. |
#
rulesType: RuleConnection
Lists all rules in the organization.
#
ArgumentsName | Description |
---|---|
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 (RuleFilter ) | The fields by which to filter the results. |
orderBy (RuleOrder ) | The field and direction by which to order the results. |
#
starredCannedRepliesType: StarredCannedReplyConnection
No description
#
ArgumentsName | Description |
---|---|
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. |
#
tagsType: TagConnection
Lists all tags.
#
ArgumentsName | Description |
---|---|
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 (TagFilter ) | The fields by which to filter the results. |
orderBy (TagOrder ) | The field and direction by which to order the results. |
#
teamsType: TeamConnection
Lists all teams in the organization.
#
ArgumentsName | Description |
---|---|
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 (TeamFilter ) | The fields by which to filter the results. |
orderBy (TeamOrder ) | The field and direction by which to order the results. |
#
themesType: ThemeConnection
Lists all Knowledge Base themes.
#
ArgumentsName | Description |
---|---|
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. |
#
walletsType: WalletConnection
Lists all wallets associated with user.
#
ArgumentsName | Description |
---|---|
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. |
features ([String!] ) | Filter wallets by features. |
options (WalletOptionsInput ) | Filter wallets by options. |
#
widgetsType: NewWidgetConnection
Lists all widgets in the organization.
#
ArgumentsName | Description |
---|---|
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 (WidgetFilter ) | Filter widgets. |