Skip to main content

Contact

A contact contains the personal information associated with someone you have interacted with using Groove.

They are identified by some unique contact detail such as an email address, a Twitter handle, or a phone number. This depends on how the contact was created.

A contact is often a customer who initated a conversation. It could also be someone who was copied in on a conversation (also called a 'collaborator'). In either case, we do not store this 'role' on the contact—rather, 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.

type Contact implements CustomFieldValuesField, Node, Timestamped {
avatarUrl: String
companies(
after: String
before: String
first: Int
last: Int
): CompanyConnection
contactType: ContactType!
conversationCount: Int!
createdAt: DateTime!
createdBy: Agent
customFieldValues(
after: String
before: String
filter: CustomFieldValuesFilter
first: Int
last: Int
): CustomFieldValueConnection
email: EmailAddress
firstName: String
hasEnduser: Boolean!
id: ID!
lastName: String
lastSeenAt: DateTime
name: String
role: ContactRole
secondaryEmails: [EmailAddress!]
updatedAt: DateTime!
updatedBy: Agent!
}

Fields​

Contact.avatarUrl ● String scalar common​

The URL of the contact's avatar.

Contact.companies ● CompanyConnection object common​

The companies that the contact belongs to.

Contact.companies.after ● String scalar common​

Returns the elements in the list that come after the specified cursor.

Contact.companies.before ● String scalar common​

Returns the elements in the list that come before the specified cursor.

Contact.companies.first ● Int scalar common​

Returns the first n elements from the list.

Contact.companies.last ● Int scalar common​

Returns the last n elements from the list.

Contact.contactType ● ContactType! non-null enum common​

The type of the contact.

Contact.conversationCount ● Int! non-null scalar common​

The total number of conversations that the contact is involved in.

Contact.createdAt ● DateTime! non-null scalar common​

The date and time that the object was created.

Contact.createdBy ● Agent object common​

The agent that created the contact.

Contact.customFieldValues ● CustomFieldValueConnection object common​

Lists all custom fields.

Contact.customFieldValues.after ● String scalar common​

Returns the elements in the list that come after the specified cursor.

Contact.customFieldValues.before ● String scalar common​

Returns the elements in the list that come before the specified cursor.

Contact.customFieldValues.filter ● CustomFieldValuesFilter input common​

Filter custom field values.

Contact.customFieldValues.first ● Int scalar common​

Returns the first n elements from the list.

Contact.customFieldValues.last ● Int scalar common​

Returns the last n elements from the list.

Contact.email ● EmailAddress scalar common​

The contact's primary email address.

Contact.firstName ● String scalar common​

The contact's first name.

Contact.hasEnduser ● Boolean! non-null scalar common​

Whether the contact has an enduser associated with it.

Contact.id ● ID! non-null scalar common​

Contact.lastName ● String scalar common​

The contact's last name.

Contact.lastSeenAt ● DateTime scalar common​

The date and time that the contact was last seen.

Contact.name ● String scalar common​

The contact's full name.

Contact.role ● ContactRole enum common​

The contact's role in a conversation.

Contact.secondaryEmails ● [EmailAddress!] list scalar common​

The contact's secondary email addresses.

Contact.updatedAt ● DateTime! non-null scalar common​

The date and time that the object was last updated.

Contact.updatedBy ● Agent! non-null object common​

The agent that last updated the contact.

Interfaces​

CustomFieldValuesField interface common​

A list of custom fields filtered by input.

Node interface common​

An object with an ID.

Timestamped interface common​

An object with timestamp fields for when it was created and last updated.

Member of​

ContactChange object ● ContactConnection object ● ContactCreatePayload object ● ContactEdge object ● ContactMergePayload object ● ContactUpdatePayload object ● Conversation interface ● EmailConversation object ● FacebookConversation object ● TwitterConversation object ● WidgetConversation object

Implemented by​

Actor union ● Author union ● CustomFieldSubjectType union ● Recipient union