Queries

companies

Type: CompanyConnection

Lists all companies.

companies(

after: String

before: String

first: Int = 0

last: Int = 0

filter: CompanyFilter

orderBy: CompanyOrder = "[object Object]"

): CompanyConnection

Arguments

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

contacts

Type: ContactConnection

Lists all contacts.

contacts(

after: String

before: String

first: Int = 0

last: Int = 0

filter: ContactFilter = "[object Object]"

orderBy: ContactOrder = "[object Object]"

): ContactConnection

Arguments

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

customFieldCategories

Type: CustomFieldCategoryConnection

Lists all custom field categories.

customFieldCategories(

after: String

before: String

first: Int = 0

last: Int = 0

filter: CustomFieldCategoryFilter

): CustomFieldCategoryConnection

Arguments

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

customFields

Type: CustomFieldConnection

Lists all custom fields.

customFields(

after: String

before: String

first: Int = 0

last: Int = 0

filter: CustomFieldFilter

): CustomFieldConnection

Arguments

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

customProfile

Type: JSON

Fetches the custom profile for a contact

customProfile(

contactId: ID!

hardRefresh: Boolean

channelId: ID = 0

): JSON

Arguments

Name	Description
contactId (ID!)	The ID of the contact.
hardRefresh (Boolean)	Whether the custom profile should be refreshed.
channelId (ID)	The ID of the channel.

emailMarketingIntegrations

Type: EmailMarketingIntegrationConnection

The installed email marketing integrations.

emailMarketingIntegrations(

after: String

before: String

first: Int = 0

last: Int = 0

): EmailMarketingIntegrationConnection!

Arguments

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

emailMarketingSubscriptions

Type: EmailMarketingSubscriptionConnection

The email marketing

emailMarketingSubscriptions(

after: String

before: String

first: Int = 0

last: Int = 0

integrationId: ID!

contactId: ID!

): EmailMarketingSubscriptionConnection!

Arguments

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

eventGroups

Type: EventGroupTypeConnection

No description

eventGroups(

after: String

before: String

first: Int = 0

last: Int = 0

filter: EventGroupsFilterInput!

): EventGroupTypeConnection!

Arguments

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

excludedDomains

Type: ExcludedDomainConnection

Lists all excluded domains.

excludedDomains(

after: String

before: String

first: Int = 0

last: Int = 0

): ExcludedDomainConnection

Arguments

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

existsForAnyAccount

Type: Boolean

Checks if there is already existing OauthCredential with provided shop domain for any Groove account.

existsForAnyAccount(

provider: String!

shopDomain: String!

): Boolean!

Arguments

Name	Description
provider (String!)	The provider to check for existing integrations for.
shopDomain (String!)	The shop domain.

integrations

Type: IntegrationUnionConnection

Connected integrations.

integrations(

after: String

before: String

first: Int = 0

last: Int = 0

filter: IntegrationsFilter

): IntegrationUnionConnection!

Arguments

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

node

Type: Node

Fetches an object given its ID.

node(

id: ID!

): Node

Arguments

Name	Description
id (ID!)	ID of the object.

nodes

Type: Node

Fetches a list of objects given a list of IDs.

nodes(

ids: [ID!]!

): [Node]!

Arguments

Name	Description
ids ([ID!]!)	IDs of the objects.

ping

Type: String

Performs a health check for the Groove GraphQL API.

ping: String!