Queries

companies#

Type: CompanyConnection

The connection type for Company.

Lists all companies.

companies(
after: String
before: String
first: Int = 0
last: Int = 0
filter: CompanyFilter
orderBy: CompanyOrder = "[object Object]"
): CompanyConnection

Arguments#

NameDescription
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

The connection type for Contact.

Lists all contacts.

contacts(
after: String
before: String
first: Int = 0
last: Int = 0
filter: ContactFilter = "[object Object]"
orderBy: ContactOrder = "[object Object]"
): ContactConnection

Arguments#

NameDescription
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

The connection type for CustomFieldCategory.

Lists all custom field categories.

customFieldCategories(
after: String
before: String
first: Int = 0
last: Int = 0
filter: CustomFieldCategoryFilter
): CustomFieldCategoryConnection

Arguments#

NameDescription
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

The connection type for CustomField.

Lists all custom fields.

customFields(
after: String
before: String
first: Int = 0
last: Int = 0
filter: CustomFieldFilter
): CustomFieldConnection

Arguments#

NameDescription
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

Represents untyped JSON

Fetches the custom profile for a contact

customProfile(
contactId: ID!
): JSON

Arguments#

NameDescription
contactId (ID!) The ID of the contact.

excludedDomains#

Type: ExcludedDomainConnection

The connection type for ExcludedDomain.

Lists all excluded domains.

excludedDomains(
after: String
before: String
first: Int = 0
last: Int = 0
): ExcludedDomainConnection

Arguments#

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

labels#

Type: LabelConnection

The connection type for Label.

Lists all labels.

labels(
after: String
before: String
first: Int = 0
last: Int = 0
orderBy: LabelOrder = "[object Object]"
): LabelConnection

Arguments#

NameDescription
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 (LabelOrder) The field and direction by which to order the results.

node#

Type: Node

An object with an ID.

Fetches an object given its ID.

node(
id: ID!
): Node

Arguments#

NameDescription
id (ID!) ID of the object.

nodes#

Type: Node

An object with an ID.

Fetches a list of objects given a list of IDs.

nodes(
ids: [ID!]!
): [Node]!

Arguments#

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

ping#

Type: String

The

Performs a health check for the Groove GraphQL API.

ping: String!

segments#

Type: SegmentConnection

The connection type for Segment.

Lists all segments.

segments(
after: String
before: String
first: Int = 0
last: Int = 0
order: SegmentOrder = "[object Object]"
): SegmentConnection

Arguments#

NameDescription
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.
order (SegmentOrder) The field and direction by which to order the results.