Nexl GraphQL API Reference
This is the Nexl GraphQL API Reference. This API documentation assumes basic understanding of GraphQL and how it works. Access the GraphIQL here.
Contact
API Endpoints
# Endpoint:
https://{region}.nexl.cloud/api/graphql
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>Queries
accessRoles
Response
Returns an AccessRoleEntries!
Example
Query
query AccessRoles {
accessRoles {
entries {
description
id
isPersisted
name
updatedAt
}
}
}
Response
{"data": {"accessRoles": {"entries": [AccessRole]}}}
allDelegateAccesses
Description
All Delegate Accesses
Response
Returns a UserDelegateAccessEntries
Example
Query
query AllDelegateAccesses(
$delegateUserUid: ID,
$page: Int!,
$perPage: Int!,
$userUid: ID
) {
allDelegateAccesses(
delegateUserUid: $delegateUserUid,
page: $page,
perPage: $perPage,
userUid: $userUid
) {
entries {
colour
delegateUserInfo {
...UserInfoFragment
}
id
isEditable
userId
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"delegateUserUid": "4",
"page": 1,
"perPage": 100,
"userUid": 4
}
Response
{
"data": {
"allDelegateAccesses": {
"entries": [UserDelegateAccess],
"pageInfo": PagingInfo
}
}
}
allObjectives
Description
Returns objectives grouped by either department, owner or office
Response
Returns [GroupedObjective!]!
Arguments
| Name | Description |
|---|---|
groupBy - ObjectiveGroupBy
|
Default = OFFICE |
status - ObjectiveStatus
|
Default = ACTIVE |
term - String
|
Example
Query
query AllObjectives(
$groupBy: ObjectiveGroupBy,
$status: ObjectiveStatus,
$term: String
) {
allObjectives(
groupBy: $groupBy,
status: $status,
term: $term
) {
group
objectives {
appendValueType
archive
createdAt
createdBy {
...UserFragment
}
currentProgress {
...ProgressFragment
}
description {
...RichContentFragment
}
id
initialValue
objectiveProgresses {
...ProgressFragment
}
owners {
...EmployeeFragment
}
projects {
...ProjectFragment
}
targetDate
targetValue
title
valueType
}
}
}
Variables
{
"groupBy": "OFFICE",
"status": "ACTIVE",
"term": "xyz789"
}
Response
{
"data": {
"allObjectives": [
{
"group": "xyz789",
"objectives": [Objective]
}
]
}
}
blockedDomains
Description
Fetch all Blocked Domains
Response
Returns a BlockedDomainEntries
Example
Query
query BlockedDomains(
$page: Int!,
$perPage: Int!
) {
blockedDomains(
page: $page,
perPage: $perPage
) {
entries {
createdAt
value
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{"page": 1, "perPage": 100}
Response
{
"data": {
"blockedDomains": {
"entries": [BlockedValue],
"pageInfo": PagingInfo
}
}
}
blockedEmails
Description
Fetch All Blocked Emails
Response
Returns a BlockedEmailEntries
Example
Query
query BlockedEmails(
$page: Int!,
$perPage: Int!
) {
blockedEmails(
page: $page,
perPage: $perPage
) {
entries {
createdAt
value
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{"page": 1, "perPage": 100}
Response
{
"data": {
"blockedEmails": {
"entries": [BlockedValue],
"pageInfo": PagingInfo
}
}
}
companies
Description
All companies
Response
Returns a CompanyEntries!
Arguments
| Name | Description |
|---|---|
filter - CompanyFiltering
|
|
orderBy - CompaniesOrderBy
|
Default = LAST_INTERACTION_DESC |
page - Int
|
Default = 1 |
perPage - Int
|
Default = 10 |
Example
Query
query Companies(
$filter: CompanyFiltering,
$orderBy: CompaniesOrderBy,
$page: Int,
$perPage: Int
) {
companies(
filter: $filter,
orderBy: $orderBy,
page: $page,
perPage: $perPage
) {
entries {
archivedAt
companyHierarchy {
...CompanyHierarchyFragment
}
companyType {
...CompanyCustomTypeFragment
}
companyTypes {
...CompanyCustomTypeFragment
}
contacts
createdAt
domain
domains
externalIdentifier {
...ExternalIdentifierFragment
}
hasCustomLogo
id
info {
...CompanyInfoFragment
}
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isBlocked
isInternal
isSubDomainCompany
logoUrl
openOpportunityCount
pendingTaskCount
secondaryTypes {
...CompanyCustomTypeFragment
}
upcomingMeetingCount
updatedAt
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"filter": CompanyFiltering,
"orderBy": "LAST_INTERACTION_DESC",
"page": 1,
"perPage": 10
}
Response
{
"data": {
"companies": {
"entries": [Company],
"pageInfo": PagingInfo
}
}
}
company
Description
Fetch Company
Example
Query
query Company($uid: String!) {
company(uid: $uid) {
archivedAt
companyHierarchy {
company {
...CompanyFragment
}
customFields {
...CustomFieldFragment
}
hierarchy {
...HierarchyFragment
}
id
level
parent {
...CompanyFragment
}
position
}
companyType {
defaultType
id
typeName
}
companyTypes {
defaultType
id
typeName
}
contacts
createdAt
domain
domains
externalIdentifier {
client
group
id
}
hasCustomLogo
id
info {
correspondenceEmails
correspondenceNumbers
description
headquarterLocation {
...CompanyOfficeLocationFragment
}
id
industryNames
internalIndustries {
...InternalIndustryFragment
}
internalIndustryNames
linkedinUrl
locations {
...LocationFragment
}
name
numberOfEmployees
primaryLocation {
...CompanyOfficeLocationFragment
}
tags
twitterUrl
website
}
interactionsLast {
emailAt
id
interactionAt
meetingAt
receivedEmailAt
sentEmailAt
}
interactionsTotal {
emails
id
interactions
meetings
receivedEmails
sentEmails
}
isBlocked
isInternal
isSubDomainCompany
logoUrl
openOpportunityCount
pendingTaskCount
secondaryTypes {
defaultType
id
typeName
}
upcomingMeetingCount
updatedAt
}
}
Variables
{"uid": "xyz789"}
Response
{
"data": {
"company": {
"archivedAt": ISO8601DateTime,
"companyHierarchy": CompanyHierarchy,
"companyType": CompanyCustomType,
"companyTypes": [CompanyCustomType],
"contacts": 123,
"createdAt": ISO8601DateTime,
"domain": "abc123",
"domains": ["abc123"],
"externalIdentifier": ExternalIdentifier,
"hasCustomLogo": true,
"id": 4,
"info": CompanyInfo,
"interactionsLast": LastAts,
"interactionsTotal": Totals,
"isBlocked": false,
"isInternal": false,
"isSubDomainCompany": true,
"logoUrl": "abc123",
"openOpportunityCount": 123,
"pendingTaskCount": 123,
"secondaryTypes": [CompanyCustomType],
"upcomingMeetingCount": 987,
"updatedAt": ISO8601DateTime
}
}
}
companyHierarchyNodes
Response
Returns a CompanyNodeEntries!
Arguments
| Name | Description |
|---|---|
filter - CompanyHierarchyNodeFiltering
|
|
page - Int
|
Default = 1 |
perPage - Int
|
Default = 100 |
Example
Query
query CompanyHierarchyNodes(
$filter: CompanyHierarchyNodeFiltering,
$page: Int,
$perPage: Int
) {
companyHierarchyNodes(
filter: $filter,
page: $page,
perPage: $perPage
) {
entries {
company {
...CompanyFragment
}
customFields {
...CustomFieldFragment
}
hierarchy {
...HierarchyFragment
}
id
level
parent {
...CompanyFragment
}
position
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"filter": CompanyHierarchyNodeFiltering,
"page": 1,
"perPage": 100
}
Response
{
"data": {
"companyHierarchyNodes": {
"entries": [CompanyHierarchy],
"pageInfo": PagingInfo
}
}
}
companyList
Response
Returns a CompanyListItem
Arguments
| Name | Description |
|---|---|
uuid - ID!
|
Example
Query
query CompanyList($uuid: ID!) {
companyList(uuid: $uuid) {
createdAt
creator {
accessRole {
...AccessRoleFragment
}
archivedAt
canArchiveContactsAndCompanies
canUpdateCompanyName
canViewActivityViewDetail
canViewEmbeddedReport
delegateAccess
email
employee {
...EmployeeFragment
}
firstName
id
isActive
isSuperAdmin
lastLoginAt
lastName
profileImageUrl
profileName
role
userId
}
discardedAt
id
memberCustomFields {
campaigns {
...CampaignFragment
}
creator {
...UserInfoFragment
}
currency {
...CurrencyFragment
}
hideFromForm
id
name
optionChoices {
...OptionChoiceFragment
}
position
schemaId
searchable
sortChoicesAlphabetically
usage
valueTypeEnum
}
name
project {
colorCode
createdAt
createdBy {
...EmployeeFragment
}
description {
...RichContentFragment
}
discardedAt
documents {
...ProjectDocumentFragment
}
firmWide
folder {
...FolderFragment
}
iconCode
id
nexlApps
objectives {
...ObjectiveFragment
}
opportunityCustomFieldSchemas {
...CustomFieldSchemaFragment
}
overviewTab {
...ProjectOverviewTabFragment
}
readOnly
tabGroupName
tabs {
...TabResultFragment
}
teamMembersCount
title
updatedAt
}
reminderSettings {
dateProperty
emailSubject
id
owners {
...ReminderSettingOwnerFragment
}
reminderDays
timePreposition
}
tabUid
updatedAt
usageMode
}
}
Variables
{"uuid": "4"}
Response
{
"data": {
"companyList": {
"createdAt": ISO8601DateTime,
"creator": User,
"discardedAt": ISO8601DateTime,
"id": 4,
"memberCustomFields": [CustomFieldSchema],
"name": "xyz789",
"project": Project,
"reminderSettings": [ReminderSetting],
"tabUid": "4",
"updatedAt": ISO8601DateTime,
"usageMode": "PERSONAL"
}
}
}
companyListMember
Response
Returns a CompanyListMember
Example
Query
query CompanyListMember(
$listMemberUid: ID!,
$listUid: ID
) {
companyListMember(
listMemberUid: $listMemberUid,
listUid: $listUid
) {
company {
archivedAt
companyHierarchy {
...CompanyHierarchyFragment
}
companyType {
...CompanyCustomTypeFragment
}
companyTypes {
...CompanyCustomTypeFragment
}
contacts
createdAt
domain
domains
externalIdentifier {
...ExternalIdentifierFragment
}
hasCustomLogo
id
info {
...CompanyInfoFragment
}
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isBlocked
isInternal
isSubDomainCompany
logoUrl
openOpportunityCount
pendingTaskCount
secondaryTypes {
...CompanyCustomTypeFragment
}
upcomingMeetingCount
updatedAt
}
companyList {
createdAt
creator {
...UserFragment
}
discardedAt
id
memberCustomFields {
...CustomFieldSchemaFragment
}
name
project {
...ProjectFragment
}
reminderSettings {
...ReminderSettingFragment
}
tabUid
updatedAt
usageMode
}
companyListId
completedTasksCount
customFields {
currency {
...CurrencyFragment
}
id
name
schemaId
stringValue
value {
... on CustomFieldCompany {
...CustomFieldCompanyFragment
}
... on CustomFieldContact {
...CustomFieldContactFragment
}
... on CustomFieldDate {
...CustomFieldDateFragment
}
... on CustomFieldEmployee {
...CustomFieldEmployeeFragment
}
... on CustomFieldFullDateTime {
...CustomFieldFullDateTimeFragment
}
... on CustomFieldMoney {
...CustomFieldMoneyFragment
}
... on CustomFieldMulti {
...CustomFieldMultiFragment
}
... on CustomFieldMultiCountry {
...CustomFieldMultiCountryFragment
}
... on CustomFieldMultiEmployee {
...CustomFieldMultiEmployeeFragment
}
... on CustomFieldNumber {
...CustomFieldNumberFragment
}
... on CustomFieldOptional {
...CustomFieldOptionalFragment
}
... on CustomFieldRichText {
...CustomFieldRichTextFragment
}
... on CustomFieldString {
...CustomFieldStringFragment
}
... on CustomFieldTimeRange {
...CustomFieldTimeRangeFragment
}
}
valueTypeEnum
}
gridCustomFields {
id
name
schemaId
schemaValueType
stringValue
value {
... on CustomCurrencyFieldGrid {
...CustomCurrencyFieldGridFragment
}
... on CustomDatetimeFieldGrid {
...CustomDatetimeFieldGridFragment
}
... on CustomEmployeeFieldGrid {
...CustomEmployeeFieldGridFragment
}
... on CustomFullDateTimeFieldGrid {
...CustomFullDateTimeFieldGridFragment
}
... on CustomMultiCompanyFieldGrid {
...CustomMultiCompanyFieldGridFragment
}
... on CustomMultiContactFieldGrid {
...CustomMultiContactFieldGridFragment
}
... on CustomMultiCountryFieldGrid {
...CustomMultiCountryFieldGridFragment
}
... on CustomMultiEmployeeFieldGrid {
...CustomMultiEmployeeFieldGridFragment
}
... on CustomMultiOptionalValueFieldGrid {
...CustomMultiOptionalValueFieldGridFragment
}
... on CustomNewlyDefinedFieldGrid {
...CustomNewlyDefinedFieldGridFragment
}
... on CustomNumberFieldGrid {
...CustomNumberFieldGridFragment
}
... on CustomOptionalValueFieldGrid {
...CustomOptionalValueFieldGridFragment
}
... on CustomRichTextFieldGrid {
...CustomRichTextFieldGridFragment
}
... on CustomTextFieldGrid {
...CustomTextFieldGridFragment
}
}
}
id
listReminders {
active
createdAt
emailSentDate
id
reminderSetting {
...ReminderSettingFragment
}
reminderSettingId
}
tasksCount
updatedAt
}
}
Variables
{"listMemberUid": 4, "listUid": "4"}
Response
{
"data": {
"companyListMember": {
"company": Company,
"companyList": CompanyListItem,
"companyListId": "4",
"completedTasksCount": 123,
"customFields": [CustomField],
"gridCustomFields": [CustomFieldGrid],
"id": "4",
"listReminders": [Reminder],
"tasksCount": 987,
"updatedAt": ISO8601DateTime
}
}
}
companyListMembers
Response
Returns a CompanyListMembers!
Example
Query
query CompanyListMembers(
$page: Int,
$perPage: Int,
$term: String,
$uid: ID!
) {
companyListMembers(
page: $page,
perPage: $perPage,
term: $term,
uid: $uid
) {
entries {
company {
...CompanyFragment
}
companyList {
...CompanyListItemFragment
}
companyListId
completedTasksCount
customFields {
...CustomFieldFragment
}
gridCustomFields {
...CustomFieldGridFragment
}
id
listReminders {
...ReminderFragment
}
tasksCount
updatedAt
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"page": 1,
"perPage": 10,
"term": "abc123",
"uid": "4"
}
Response
{
"data": {
"companyListMembers": {
"entries": [CompanyListMember],
"pageInfo": PagingInfo
}
}
}
companyLists
Response
Returns a CompanyListEntries!
Example
Query
query CompanyLists(
$page: Int,
$perPage: Int,
$personalOnly: Boolean,
$projectUuid: ID
) {
companyLists(
page: $page,
perPage: $perPage,
personalOnly: $personalOnly,
projectUuid: $projectUuid
) {
entries {
createdAt
creator {
...UserFragment
}
discardedAt
id
memberCustomFields {
...CustomFieldSchemaFragment
}
name
project {
...ProjectFragment
}
reminderSettings {
...ReminderSettingFragment
}
tabUid
updatedAt
usageMode
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"page": 1,
"perPage": 10,
"personalOnly": true,
"projectUuid": "4"
}
Response
{
"data": {
"companyLists": {
"entries": [CompanyListItem],
"pageInfo": PagingInfo
}
}
}
companyNotes
Description
Company notes
Response
Returns a CompanyNoteList!
Example
Query
query CompanyNotes(
$companyUid: ID,
$contactUid: ID,
$page: Int,
$perPage: Int,
$search: String
) {
companyNotes(
companyUid: $companyUid,
contactUid: $contactUid,
page: $page,
perPage: $perPage,
search: $search
) {
entries {
access
company {
...CompanyFragment
}
contact {
...ContactFragment
}
content {
...RichContentFragment
}
createdAt
creator {
...UserFragment
}
creatorName
id
updatedAt
updater {
...UserFragment
}
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"companyUid": null,
"contactUid": null,
"page": 1,
"perPage": 10,
"search": null
}
Response
{
"data": {
"companyNotes": {
"entries": [CompanyNote],
"pageInfo": PagingInfo
}
}
}
companyOfficeLocations
Description
company office locations
Response
Returns a CompanyOfficeLocationList!
Example
Query
query CompanyOfficeLocations(
$companyId: ID!,
$page: Int,
$perPage: Int
) {
companyOfficeLocations(
companyId: $companyId,
page: $page,
perPage: $perPage
) {
entries {
companyOfficeLocationId
headquarter
id
labels
location {
...LocationFragment
}
primary
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{"companyId": 4, "page": 123, "perPage": 123}
Response
{
"data": {
"companyOfficeLocations": {
"entries": [CompanyOfficeLocation],
"pageInfo": PagingInfo
}
}
}
companyRelationshipPartners
Description
Get a list of all relationship partners
Response
Returns a RelationshipPartnerList!
Example
Query
query CompanyRelationshipPartners(
$companyUid: String,
$page: Int,
$perPage: Int
) {
companyRelationshipPartners(
companyUid: $companyUid,
page: $page,
perPage: $perPage
) {
entries {
company {
...CompanyFragment
}
discardedAt
employee {
...EmployeeFragment
}
id
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{"companyUid": null, "page": 1, "perPage": 10}
Response
{
"data": {
"companyRelationshipPartners": {
"entries": [RelationshipPartner],
"pageInfo": PagingInfo
}
}
}
contact
Description
Fetch Contact
Example
Query
query Contact($uid: String!) {
contact(uid: $uid) {
archivedAt
changedJob
company {
archivedAt
companyHierarchy {
...CompanyHierarchyFragment
}
companyType {
...CompanyCustomTypeFragment
}
companyTypes {
...CompanyCustomTypeFragment
}
contacts
createdAt
domain
domains
externalIdentifier {
...ExternalIdentifierFragment
}
hasCustomLogo
id
info {
...CompanyInfoFragment
}
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isBlocked
isInternal
isSubDomainCompany
logoUrl
openOpportunityCount
pendingTaskCount
secondaryTypes {
...CompanyCustomTypeFragment
}
upcomingMeetingCount
updatedAt
}
contactCompanySwitch {
company {
...CompanyFragment
}
creator {
...UserFragment
}
id
knownDetail
}
createdAt
emailAddresses
id
inMyContacts
info {
customFields {
...CustomFieldFragment
}
department
displayName
educations
firstName
gender
id
imageUrl
jobTitle
lastName
linkedinUrl
location {
...LocationFragment
}
office
phoneNumbers
phoneNumbersWithType {
...PhoneNumberFragment
}
tags
twitterUrl
}
interactionsIsEngaged
interactionsLast {
emailAt
id
interactionAt
meetingAt
receivedEmailAt
sentEmailAt
}
interactionsTotal {
emails
id
interactions
meetings
receivedEmails
sentEmails
}
isActive
isArchived
isEmployee
isKeyContact
isPersonal
marketingListConsent {
autoChangedReason
howWasConsentGiven
id
status
whenWasConsentGiven
}
officeLocation {
companyOfficeLocationId
headquarter
id
labels
location {
...LocationFragment
}
primary
}
primaryEmail
unarchiveOnNextInteraction
updatedAt
}
}
Variables
{"uid": "abc123"}
Response
{
"data": {
"contact": {
"archivedAt": ISO8601DateTime,
"changedJob": false,
"company": Company,
"contactCompanySwitch": ContactCompanySwitch,
"createdAt": ISO8601DateTime,
"emailAddresses": ["[email protected]"],
"id": "4",
"inMyContacts": true,
"info": ContactInfo,
"interactionsIsEngaged": false,
"interactionsLast": LastAts,
"interactionsTotal": Totals,
"isActive": false,
"isArchived": true,
"isEmployee": true,
"isKeyContact": true,
"isPersonal": false,
"marketingListConsent": ContactConsent,
"officeLocation": CompanyOfficeLocation,
"primaryEmail": "[email protected]",
"unarchiveOnNextInteraction": true,
"updatedAt": ISO8601DateTime
}
}
}
contactConsent
Response
Returns a ContactConsent
Arguments
| Name | Description |
|---|---|
contactUid - ID!
|
Example
Query
query ContactConsent($contactUid: ID!) {
contactConsent(contactUid: $contactUid) {
autoChangedReason
howWasConsentGiven
id
status
whenWasConsentGiven
}
}
Variables
{"contactUid": 4}
Response
{
"data": {
"contactConsent": {
"autoChangedReason": "abc123",
"howWasConsentGiven": "abc123",
"id": "abc123",
"status": "CONSENT_GIVEN",
"whenWasConsentGiven": ISO8601Date
}
}
}
contacts
Description
Filtered Contacts
Response
Returns a ContactList!
Arguments
| Name | Description |
|---|---|
filter - ContactsFiltering
|
Default = {companyRelationshipPartnerUids: [], companyTypeUids: [], consentStatuses: [], excludeExternal: false, groups: [], includeArchived: false, includeInternalContact: false, keyActivityTitles: [], knowByUids: [], missingKeyData: false, term: null, timeFilters: [], withBouncedEmails: false, withJobChanges: false} |
filters - [ContactFilter!]
|
Default = [] |
orderBy - ContactsOrderBy
|
Default = null |
page - Int
|
Default = 1 |
perPage - Int
|
Default = 10 |
Example
Query
query Contacts(
$filter: ContactsFiltering,
$filters: [ContactFilter!],
$orderBy: ContactsOrderBy,
$page: Int,
$perPage: Int
) {
contacts(
filter: $filter,
filters: $filters,
orderBy: $orderBy,
page: $page,
perPage: $perPage
) {
entries {
archivedAt
changedJob
company {
...CompanyFragment
}
contactCompanySwitch {
...ContactCompanySwitchFragment
}
createdAt
emailAddresses
id
inMyContacts
info {
...ContactInfoFragment
}
interactionsIsEngaged
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isActive
isArchived
isEmployee
isKeyContact
isPersonal
marketingListConsent {
...ContactConsentFragment
}
officeLocation {
...CompanyOfficeLocationFragment
}
primaryEmail
unarchiveOnNextInteraction
updatedAt
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"filter": {
"companyRelationshipPartnerUids": [""],
"companyTypeUids": [""],
"consentStatuses": [""],
"excludeExternal": "false",
"groups": [""],
"includeArchived": "false",
"includeInternalContact": "false",
"keyActivityTitles": [""],
"knowByUids": [""],
"missingKeyData": "false",
"term": "null",
"timeFilters": [""],
"withBouncedEmails": "false",
"withJobChanges": "false"
},
"filters": [""],
"orderBy": "null",
"page": 1,
"perPage": 10
}
Response
{
"data": {
"contacts": {
"entries": [Contact],
"pageInfo": PagingInfo
}
}
}
customFieldSchemas
Description
List of configured custom fields
Response
Returns a CustomFieldSchemasList!
Arguments
| Name | Description |
|---|---|
ownerType - CustomFieldSchemaOwner!
|
Example
Query
query CustomFieldSchemas($ownerType: CustomFieldSchemaOwner!) {
customFieldSchemas(ownerType: $ownerType) {
entries {
campaigns {
...CampaignFragment
}
creator {
...UserInfoFragment
}
currency {
...CurrencyFragment
}
hideFromForm
id
name
optionChoices {
...OptionChoiceFragment
}
position
schemaId
searchable
sortChoicesAlphabetically
usage
valueTypeEnum
}
}
}
Variables
{"ownerType": "CONTACT"}
Response
{
"data": {
"customFieldSchemas": {"entries": [CustomFieldSchema]}
}
}
deploymentInfo
Response
Returns a DeploymentInfo!
Example
Query
query DeploymentInfo {
deploymentInfo {
releaseCreatedAt
releaseVersion
}
}
Response
{
"data": {
"deploymentInfo": {
"releaseCreatedAt": ISO8601DateTime,
"releaseVersion": "xyz789"
}
}
}
emailMarketingCampaigns
Description
Email marketing campaigns
Response
Returns a Campaigns
Arguments
| Name | Description |
|---|---|
filter - CampaignsFilterInput
|
Default = {} |
page - Int
|
Default = 1 |
perPage - Int
|
Default = 25 |
Example
Query
query EmailMarketingCampaigns(
$filter: CampaignsFilterInput,
$page: Int,
$perPage: Int
) {
emailMarketingCampaigns(
filter: $filter,
page: $page,
perPage: $perPage
) {
entries {
allowContinuousResend
analytics {
...CampaignAnalyticsFragment
}
attachment {
...FileFragment
}
clickTracking
continuous
createdAt
createdBy {
...UserFragment
}
fromEmail
id
openTracking
project {
...ProjectFragment
}
projectUrl
recipientList {
...ListFragment
}
recipientListFilter {
...CampaignRecipientListFilterFragment
}
scheduledAt
sender {
...SenderFragment
}
sentAt
status
subject
templateHtml
templateJson
title
updatedAt
usageMode
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{"filter": {}, "page": 1, "perPage": 25}
Response
{
"data": {
"emailMarketingCampaigns": {
"entries": [Campaign],
"pageInfo": PagingInfo
}
}
}
emailMarketingTemplate
Example
Query
query EmailMarketingTemplate($uid: ID!) {
emailMarketingTemplate(uid: $uid) {
archivedAt
id
templateHtml
templateJson
thumbnail
title
}
}
Variables
{"uid": 4}
Response
{
"data": {
"emailMarketingTemplate": {
"archivedAt": ISO8601DateTime,
"id": "4",
"templateHtml": "abc123",
"templateJson": "abc123",
"thumbnail": "abc123",
"title": "abc123"
}
}
}
employees
Response
Returns an EmployeeList!
Example
Query
query Employees(
$emails: [String!],
$page: Int,
$perPage: Int,
$term: String
) {
employees(
emails: $emails,
page: $page,
perPage: $perPage,
term: $term
) {
entries {
contact {
...ContactFragment
}
department {
...DepartmentFragment
}
email
hidden
id
info {
...ContactInfoFragment
}
office {
...OfficeFragment
}
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"emails": [""],
"page": 1,
"perPage": 10,
"term": "abc123"
}
Response
{
"data": {
"employees": {
"entries": [Employee],
"pageInfo": PagingInfo
}
}
}
exportAudits
Description
Export audtis
Response
Returns an ExportAuditEntries!
Arguments
| Name | Description |
|---|---|
createdAfter - ISO8601DateTime
|
|
createdBefore - ISO8601DateTime
|
|
page - Int
|
Default = 1 |
perPage - Int
|
Default = 20 |
Example
Query
query ExportAudits(
$createdAfter: ISO8601DateTime,
$createdBefore: ISO8601DateTime,
$page: Int,
$perPage: Int
) {
exportAudits(
createdAfter: $createdAfter,
createdBefore: $createdBefore,
page: $page,
perPage: $perPage
) {
entries {
createdAt
dataType
id
performer {
...UserFragment
}
primaryName
rowCount
secondaryName
user {
...UserFragment
}
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"createdAfter": ISO8601DateTime,
"createdBefore": ISO8601DateTime,
"page": 1,
"perPage": 20
}
Response
{
"data": {
"exportAudits": {
"entries": [ExportAudit],
"pageInfo": PagingInfo
}
}
}
genericListItem
Response
Returns a GenericListItem
Arguments
| Name | Description |
|---|---|
itemUid - ID!
|
Example
Query
query GenericListItem($itemUid: ID!) {
genericListItem(itemUid: $itemUid) {
completedTasksCount
createdAt
customFields {
currency {
...CurrencyFragment
}
id
name
schemaId
stringValue
value {
... on CustomFieldCompany {
...CustomFieldCompanyFragment
}
... on CustomFieldContact {
...CustomFieldContactFragment
}
... on CustomFieldDate {
...CustomFieldDateFragment
}
... on CustomFieldEmployee {
...CustomFieldEmployeeFragment
}
... on CustomFieldFullDateTime {
...CustomFieldFullDateTimeFragment
}
... on CustomFieldMoney {
...CustomFieldMoneyFragment
}
... on CustomFieldMulti {
...CustomFieldMultiFragment
}
... on CustomFieldMultiCountry {
...CustomFieldMultiCountryFragment
}
... on CustomFieldMultiEmployee {
...CustomFieldMultiEmployeeFragment
}
... on CustomFieldNumber {
...CustomFieldNumberFragment
}
... on CustomFieldOptional {
...CustomFieldOptionalFragment
}
... on CustomFieldRichText {
...CustomFieldRichTextFragment
}
... on CustomFieldString {
...CustomFieldStringFragment
}
... on CustomFieldTimeRange {
...CustomFieldTimeRangeFragment
}
}
valueTypeEnum
}
genericList {
createdAt
customFieldSchemas {
...CustomFieldSchemaFragment
}
discardedAt
id
items {
...GenericListItemFragment
}
reminderSettings {
...ReminderSettingFragment
}
title
updatedAt
}
gridCustomFields {
id
name
schemaId
schemaValueType
stringValue
value {
... on CustomCurrencyFieldGrid {
...CustomCurrencyFieldGridFragment
}
... on CustomDatetimeFieldGrid {
...CustomDatetimeFieldGridFragment
}
... on CustomEmployeeFieldGrid {
...CustomEmployeeFieldGridFragment
}
... on CustomFullDateTimeFieldGrid {
...CustomFullDateTimeFieldGridFragment
}
... on CustomMultiCompanyFieldGrid {
...CustomMultiCompanyFieldGridFragment
}
... on CustomMultiContactFieldGrid {
...CustomMultiContactFieldGridFragment
}
... on CustomMultiCountryFieldGrid {
...CustomMultiCountryFieldGridFragment
}
... on CustomMultiEmployeeFieldGrid {
...CustomMultiEmployeeFieldGridFragment
}
... on CustomMultiOptionalValueFieldGrid {
...CustomMultiOptionalValueFieldGridFragment
}
... on CustomNewlyDefinedFieldGrid {
...CustomNewlyDefinedFieldGridFragment
}
... on CustomNumberFieldGrid {
...CustomNumberFieldGridFragment
}
... on CustomOptionalValueFieldGrid {
...CustomOptionalValueFieldGridFragment
}
... on CustomRichTextFieldGrid {
...CustomRichTextFieldGridFragment
}
... on CustomTextFieldGrid {
...CustomTextFieldGridFragment
}
}
}
id
listReminders {
active
createdAt
emailSentDate
id
reminderSetting {
...ReminderSettingFragment
}
reminderSettingId
}
tasksCount
updatedAt
}
}
Variables
{"itemUid": 4}
Response
{
"data": {
"genericListItem": {
"completedTasksCount": 123,
"createdAt": ISO8601DateTime,
"customFields": [CustomField],
"genericList": GenericList,
"gridCustomFields": [CustomFieldGrid],
"id": 4,
"listReminders": [Reminder],
"tasksCount": 987,
"updatedAt": ISO8601DateTime
}
}
}
genericListItems
Response
Returns a GenericListItemEntries!
Example
Query
query GenericListItems(
$genericListUid: ID!,
$page: Int!,
$perPage: Int!
) {
genericListItems(
genericListUid: $genericListUid,
page: $page,
perPage: $perPage
) {
entries {
completedTasksCount
createdAt
customFields {
...CustomFieldFragment
}
genericList {
...GenericListFragment
}
gridCustomFields {
...CustomFieldGridFragment
}
id
listReminders {
...ReminderFragment
}
tasksCount
updatedAt
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"genericListUid": "4",
"page": 1,
"perPage": 10
}
Response
{
"data": {
"genericListItems": {
"entries": [GenericListItem],
"pageInfo": PagingInfo
}
}
}
keyActivities
Description
List of BD and marketing interactions
Response
Returns an InteractionDetailList!
Arguments
| Name | Description |
|---|---|
filter - InteractionDetailsFilter
|
|
orderBy - InteractionDetailsOrderBy
|
|
page - Int
|
Default = 1 |
perPage - Int
|
Default = 10 |
Example
Query
query KeyActivities(
$filter: InteractionDetailsFilter,
$orderBy: InteractionDetailsOrderBy,
$page: Int,
$perPage: Int
) {
keyActivities(
filter: $filter,
orderBy: $orderBy,
page: $page,
perPage: $perPage
) {
entries {
activityTitle
calendarMeeting {
...EmployeeMeetingFragment
}
category
contactsInvolved {
...ContactFragment
}
description
id
interaction {
...PartitionedInteractionFragment
}
interactionEndAt
interactionOn
involvedCompanies {
...CompanyFragment
}
involvedContacts {
...ContactFragment
}
keyActivityListMember {
...KeyActivityListMemberFragment
}
notes {
...RichContentFragment
}
sourceReferenceId
staffInvolved {
...EmployeeFragment
}
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"filter": InteractionDetailsFilter,
"orderBy": InteractionDetailsOrderBy,
"page": 1,
"perPage": 10
}
Response
{
"data": {
"keyActivities": {
"entries": [KeyActivity],
"pageInfo": PagingInfo
}
}
}
list
Example
Query
query List($uid: ID!) {
list(uid: $uid) {
allowDuplicates
category
clean {
beenCleaned
cleanEnd
cleanStart
id
listType
percentComplete
status
totalBounced
totalConsentNotGiven
totalHighRisk
totalLowRisk
totalMediumRisk
totalMembers
totalUnengaged
totalUnsubscribed
}
contactsCount
createdAt
creator {
accessRole {
...AccessRoleFragment
}
archivedAt
canArchiveContactsAndCompanies
canUpdateCompanyName
canViewActivityViewDetail
canViewEmbeddedReport
delegateAccess
email
employee {
...EmployeeFragment
}
firstName
id
isActive
isSuperAdmin
lastLoginAt
lastName
profileImageUrl
profileName
role
userId
}
discardedAt
filterCriteria
id
listType
memberCustomFields {
campaigns {
...CampaignFragment
}
creator {
...UserInfoFragment
}
currency {
...CurrencyFragment
}
hideFromForm
id
name
optionChoices {
...OptionChoiceFragment
}
position
schemaId
searchable
sortChoicesAlphabetically
usage
valueTypeEnum
}
name
reminderSettings {
dateProperty
emailSubject
id
owners {
...ReminderSettingOwnerFragment
}
reminderDays
timePreposition
}
renderMode
searchTerm
tabUid
updatedAt
}
}
Variables
{"uid": "4"}
Response
{
"data": {
"list": {
"allowDuplicates": false,
"category": "CLIENT_ALERT",
"clean": Clean,
"contactsCount": 987,
"createdAt": ISO8601DateTime,
"creator": User,
"discardedAt": ISO8601DateTime,
"filterCriteria": {},
"id": "4",
"listType": "DYNAMIC",
"memberCustomFields": [CustomFieldSchema],
"name": "abc123",
"reminderSettings": [ReminderSetting],
"renderMode": "CLIENT_SIDE",
"searchTerm": "xyz789",
"tabUid": 4,
"updatedAt": ISO8601DateTime
}
}
}
listMember
Response
Returns a ListMember
Example
Query
query ListMember(
$listMemberUid: ID!,
$listUid: ID
) {
listMember(
listMemberUid: $listMemberUid,
listUid: $listUid
) {
completedTasksCount
contact {
archivedAt
changedJob
company {
...CompanyFragment
}
contactCompanySwitch {
...ContactCompanySwitchFragment
}
createdAt
emailAddresses
id
inMyContacts
info {
...ContactInfoFragment
}
interactionsIsEngaged
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isActive
isArchived
isEmployee
isKeyContact
isPersonal
marketingListConsent {
...ContactConsentFragment
}
officeLocation {
...CompanyOfficeLocationFragment
}
primaryEmail
unarchiveOnNextInteraction
updatedAt
}
createdAt
creator {
accessRole {
...AccessRoleFragment
}
archivedAt
canArchiveContactsAndCompanies
canUpdateCompanyName
canViewActivityViewDetail
canViewEmbeddedReport
delegateAccess
email
employee {
...EmployeeFragment
}
firstName
id
isActive
isSuperAdmin
lastLoginAt
lastName
profileImageUrl
profileName
role
userId
}
customFields {
currency {
...CurrencyFragment
}
id
name
schemaId
stringValue
value {
... on CustomFieldCompany {
...CustomFieldCompanyFragment
}
... on CustomFieldContact {
...CustomFieldContactFragment
}
... on CustomFieldDate {
...CustomFieldDateFragment
}
... on CustomFieldEmployee {
...CustomFieldEmployeeFragment
}
... on CustomFieldFullDateTime {
...CustomFieldFullDateTimeFragment
}
... on CustomFieldMoney {
...CustomFieldMoneyFragment
}
... on CustomFieldMulti {
...CustomFieldMultiFragment
}
... on CustomFieldMultiCountry {
...CustomFieldMultiCountryFragment
}
... on CustomFieldMultiEmployee {
...CustomFieldMultiEmployeeFragment
}
... on CustomFieldNumber {
...CustomFieldNumberFragment
}
... on CustomFieldOptional {
...CustomFieldOptionalFragment
}
... on CustomFieldRichText {
...CustomFieldRichTextFragment
}
... on CustomFieldString {
...CustomFieldStringFragment
}
... on CustomFieldTimeRange {
...CustomFieldTimeRangeFragment
}
}
valueTypeEnum
}
discardedAt
id
listId
listReminders {
active
createdAt
emailSentDate
id
reminderSetting {
...ReminderSettingFragment
}
reminderSettingId
}
myContact {
archived
classified
contact {
...ContactFragment
}
createdAt
id
interactionMaximum {
...InteractionMaximumFragment
}
stayInTouch {
...MyStayInTouchFragment
}
}
remover {
accessRole {
...AccessRoleFragment
}
archivedAt
canArchiveContactsAndCompanies
canUpdateCompanyName
canViewActivityViewDetail
canViewEmbeddedReport
delegateAccess
email
employee {
...EmployeeFragment
}
firstName
id
isActive
isSuperAdmin
lastLoginAt
lastName
profileImageUrl
profileName
role
userId
}
tasksCount
updatedAt
}
}
Variables
{"listMemberUid": "4", "listUid": 4}
Response
{
"data": {
"listMember": {
"completedTasksCount": 123,
"contact": Contact,
"createdAt": ISO8601DateTime,
"creator": User,
"customFields": [CustomField],
"discardedAt": ISO8601DateTime,
"id": 4,
"listId": "4",
"listReminders": [Reminder],
"myContact": MyContact,
"remover": User,
"tasksCount": 987,
"updatedAt": ISO8601DateTime
}
}
}
listMembers
Description
Members in a contact list
Response
Returns a ListMembers!
Arguments
| Name | Description |
|---|---|
contactUids - [ID!]
|
Deprecated: use Filter#contactUidsNoDuplicates |
filter - ListMembersFilter
|
Default = {addedBy: [], communicationCondition: ANY, consentStatus: [], excludeClassified: false, excludeHidden: false, marketingListOnly: false, myContacts: false, scope: KEPT, tags: []} |
orderBy - ListMembersOrderBy
|
Default = CREATED_AT_ASC |
page - Int
|
Default = 1 |
perPage - Int
|
Default = 10 |
term - String
|
Default = "" |
uid - ID
|
ID of contact list |
withMissingFields - Boolean
|
Default = false |
Example
Query
query ListMembers(
$contactUids: [ID!],
$filter: ListMembersFilter,
$orderBy: ListMembersOrderBy,
$page: Int,
$perPage: Int,
$term: String,
$uid: ID,
$withMissingFields: Boolean
) {
listMembers(
contactUids: $contactUids,
filter: $filter,
orderBy: $orderBy,
page: $page,
perPage: $perPage,
term: $term,
uid: $uid,
withMissingFields: $withMissingFields
) {
entries {
completedTasksCount
contact {
...ContactFragment
}
createdAt
creator {
...UserFragment
}
customFields {
...CustomFieldFragment
}
discardedAt
id
listId
listReminders {
...ReminderFragment
}
myContact {
...MyContactFragment
}
remover {
...UserFragment
}
tasksCount
updatedAt
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"contactUids": [4],
"filter": {
"addedBy": [""],
"communicationCondition": "ANY",
"consentStatus": [""],
"excludeClassified": "false",
"excludeHidden": "false",
"marketingListOnly": "false",
"myContacts": "false",
"scope": "KEPT",
"tags": [""]
},
"orderBy": "CREATED_AT_ASC",
"page": 1,
"perPage": 10,
"term": "",
"uid": "4",
"withMissingFields": false
}
Response
{
"data": {
"listMembers": {
"entries": [ListMember],
"pageInfo": PagingInfo
}
}
}
lists
Description
Contact lists
Response
Returns a ListEntries!
Arguments
| Name | Description |
|---|---|
filter - ListFiltering
|
Default = {category: null, listStatus: ACTIVE, listType: null, projectUuid: null, term: null, usageModes: []} |
orderBy - ListsOrderBy
|
Default = null |
page - Int
|
Default = 1 |
perPage - Int
|
Default = 10 |
Example
Query
query Lists(
$filter: ListFiltering,
$orderBy: ListsOrderBy,
$page: Int,
$perPage: Int
) {
lists(
filter: $filter,
orderBy: $orderBy,
page: $page,
perPage: $perPage
) {
entries {
allowDuplicates
category
clean {
...CleanFragment
}
contactsCount
createdAt
creator {
...UserFragment
}
discardedAt
filterCriteria
id
listType
memberCustomFields {
...CustomFieldSchemaFragment
}
name
reminderSettings {
...ReminderSettingFragment
}
renderMode
searchTerm
tabUid
updatedAt
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"filter": {
"category": "null",
"listStatus": "ACTIVE",
"listType": "null",
"projectUuid": "null",
"term": "null",
"usageModes": [""]
},
"orderBy": "null",
"page": 1,
"perPage": 10
}
Response
{
"data": {
"lists": {
"entries": [List],
"pageInfo": PagingInfo
}
}
}
marketingContactLists
Description
Contact lists
Response
Returns a ListEntries!
Arguments
| Name | Description |
|---|---|
filter - MarketingListFiltering
|
Default = {category: null, listType: null, term: null} |
orderBy - ListsOrderBy
|
Default = null |
page - Int
|
Default = 1 |
perPage - Int
|
Default = 10 |
Example
Query
query MarketingContactLists(
$filter: MarketingListFiltering,
$orderBy: ListsOrderBy,
$page: Int,
$perPage: Int
) {
marketingContactLists(
filter: $filter,
orderBy: $orderBy,
page: $page,
perPage: $perPage
) {
entries {
allowDuplicates
category
clean {
...CleanFragment
}
contactsCount
createdAt
creator {
...UserFragment
}
discardedAt
filterCriteria
id
listType
memberCustomFields {
...CustomFieldSchemaFragment
}
name
reminderSettings {
...ReminderSettingFragment
}
renderMode
searchTerm
tabUid
updatedAt
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"filter": {"category": "null", "listType": "null", "term": "null"},
"orderBy": "null",
"page": 1,
"perPage": 10
}
Response
{
"data": {
"marketingContactLists": {
"entries": [List],
"pageInfo": PagingInfo
}
}
}
marketingListSyncRequest
Response
Returns a MarketingListSyncRequest
Arguments
| Name | Description |
|---|---|
uid - ID!
|
Example
Query
query MarketingListSyncRequest($uid: ID!) {
marketingListSyncRequest(uid: $uid) {
connectedList {
campaignManager {
...CampaignManagerFragment
}
connected
externalUrl
id
lastSyncAt
lastSyncError
list {
...ListFragment
}
mappings {
...ConnectedListMappingFragment
}
nameOnEms
outOfSync
syncing
}
createdAt
id
}
}
Variables
{"uid": 4}
Response
{
"data": {
"marketingListSyncRequest": {
"connectedList": ConnectedList,
"createdAt": ISO8601DateTime,
"id": 4
}
}
}
meetings
Response
Returns a MeetingList!
Arguments
| Name | Description |
|---|---|
filter - MeetingsFiltering
|
|
order - EmployeeMeetingsOrderBy!
|
Default = START_TIME_ASC |
ownership - MeetingsOwnership!
|
Default = USER |
page - Int
|
Default = 1 |
perPage - Int
|
Default = 10 |
timeScope - MeetingsTimeScope!
|
Default = ALL |
Example
Query
query Meetings(
$filter: MeetingsFiltering,
$order: EmployeeMeetingsOrderBy!,
$ownership: MeetingsOwnership!,
$page: Int,
$perPage: Int,
$timeScope: MeetingsTimeScope!
) {
meetings(
filter: $filter,
order: $order,
ownership: $ownership,
page: $page,
perPage: $perPage,
timeScope: $timeScope
) {
entries {
companies {
...CompanyFragment
}
contacts {
...ContactFragment
}
endTime
id
isCancelled
keyActivity {
...KeyActivityFragment
}
meetingOrganizer {
...ContactFragment
}
relevantMeetings {
...UpcomingMeetingFragment
}
sourceEventReference
startTime
title
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"filter": MeetingsFiltering,
"order": "START_TIME_ASC",
"ownership": "USER",
"page": 1,
"perPage": 10,
"timeScope": "ALL"
}
Response
{
"data": {
"meetings": {
"entries": [EmployeeMeeting],
"pageInfo": PagingInfo
}
}
}
opportunitiesForGrid
Description
Return all tenant opportunities optimized for Ag-Grid
Response
Returns an OpportunityGridTypeList!
Arguments
| Name | Description |
|---|---|
filter - CompanyGoalFiltering
|
|
page - Int!
|
Default = 1 |
perPage - Int!
|
Default = 1000 |
Example
Query
query OpportunitiesForGrid(
$filter: CompanyGoalFiltering,
$page: Int!,
$perPage: Int!
) {
opportunitiesForGrid(
filter: $filter,
page: $page,
perPage: $perPage
) {
entries {
assignedTo {
...EmployeeGridFragment
}
commsLast {
...LastAtsFragment
}
company {
...CompanyGridFragment
}
createdAt
createdBy {
...UserGridFragment
}
customFields {
...CustomFieldGridFragment
}
customStatus {
...OpportunityTrackingCustomStatusFragment
}
date
id
keyContacts {
...ContactGridFragment
}
othersIncluded {
...EmployeeGridFragment
}
proposedFeeAmount {
...MoneyFragment
}
referralSource {
...ContactGridFragment
}
tags
title
trackingNumber
updatedAt
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"filter": CompanyGoalFiltering,
"page": 1,
"perPage": 1000
}
Response
{
"data": {
"opportunitiesForGrid": {
"entries": [OpportunityGrid],
"pageInfo": PagingInfo
}
}
}
opportunity
Description
Return company opportunity
Response
Returns an Opportunity
Arguments
| Name | Description |
|---|---|
uid - ID!
|
Example
Query
query Opportunity($uid: ID!) {
opportunity(uid: $uid) {
archived
assignedTo {
contact {
...ContactFragment
}
department {
...DepartmentFragment
}
email
hidden
id
info {
...ContactInfoFragment
}
office {
...OfficeFragment
}
}
company {
archivedAt
companyHierarchy {
...CompanyHierarchyFragment
}
companyType {
...CompanyCustomTypeFragment
}
companyTypes {
...CompanyCustomTypeFragment
}
contacts
createdAt
domain
domains
externalIdentifier {
...ExternalIdentifierFragment
}
hasCustomLogo
id
info {
...CompanyInfoFragment
}
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isBlocked
isInternal
isSubDomainCompany
logoUrl
openOpportunityCount
pendingTaskCount
secondaryTypes {
...CompanyCustomTypeFragment
}
upcomingMeetingCount
updatedAt
}
contactLast {
emailAt
id
interactionAt
meetingAt
receivedEmailAt
sentEmailAt
}
createdAt
createdBy {
accessRole {
...AccessRoleFragment
}
archivedAt
canArchiveContactsAndCompanies
canUpdateCompanyName
canViewActivityViewDetail
canViewEmbeddedReport
delegateAccess
email
employee {
...EmployeeFragment
}
firstName
id
isActive
isSuperAdmin
lastLoginAt
lastName
profileImageUrl
profileName
role
userId
}
customFields {
currency {
...CurrencyFragment
}
id
name
schemaId
stringValue
value {
... on CustomFieldCompany {
...CustomFieldCompanyFragment
}
... on CustomFieldContact {
...CustomFieldContactFragment
}
... on CustomFieldDate {
...CustomFieldDateFragment
}
... on CustomFieldEmployee {
...CustomFieldEmployeeFragment
}
... on CustomFieldFullDateTime {
...CustomFieldFullDateTimeFragment
}
... on CustomFieldMoney {
...CustomFieldMoneyFragment
}
... on CustomFieldMulti {
...CustomFieldMultiFragment
}
... on CustomFieldMultiCountry {
...CustomFieldMultiCountryFragment
}
... on CustomFieldMultiEmployee {
...CustomFieldMultiEmployeeFragment
}
... on CustomFieldNumber {
...CustomFieldNumberFragment
}
... on CustomFieldOptional {
...CustomFieldOptionalFragment
}
... on CustomFieldRichText {
...CustomFieldRichTextFragment
}
... on CustomFieldString {
...CustomFieldStringFragment
}
... on CustomFieldTimeRange {
...CustomFieldTimeRangeFragment
}
}
valueTypeEnum
}
customStatus {
id
name
outcome
position
startingStatus
}
date
description {
html
id
plainText
trixHtml
}
documents {
... on DocumentFile {
...DocumentFileFragment
}
... on DocumentUrl {
...DocumentUrlFragment
}
}
emailBody {
html
id
plainText
trixHtml
}
id
includedLawyers {
contact {
...ContactFragment
}
department {
...DepartmentFragment
}
email
hidden
id
info {
...ContactInfoFragment
}
office {
...OfficeFragment
}
}
keyContacts {
archivedAt
changedJob
company {
...CompanyFragment
}
contactCompanySwitch {
...ContactCompanySwitchFragment
}
createdAt
emailAddresses
id
inMyContacts
info {
...ContactInfoFragment
}
interactionsIsEngaged
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isActive
isArchived
isEmployee
isKeyContact
isPersonal
marketingListConsent {
...ContactConsentFragment
}
officeLocation {
...CompanyOfficeLocationFragment
}
primaryEmail
unarchiveOnNextInteraction
updatedAt
}
outcome
project {
colorCode
createdAt
createdBy {
...EmployeeFragment
}
description {
...RichContentFragment
}
discardedAt
documents {
...ProjectDocumentFragment
}
firmWide
folder {
...FolderFragment
}
iconCode
id
nexlApps
objectives {
...ObjectiveFragment
}
opportunityCustomFieldSchemas {
...CustomFieldSchemaFragment
}
overviewTab {
...ProjectOverviewTabFragment
}
readOnly
tabGroupName
tabs {
...TabResultFragment
}
teamMembersCount
title
updatedAt
}
proposedFee
proposedFeeAmount {
cents
currency {
...CurrencyFragment
}
format
}
receivedReferral
referralSource {
archivedAt
changedJob
company {
...CompanyFragment
}
contactCompanySwitch {
...ContactCompanySwitchFragment
}
createdAt
emailAddresses
id
inMyContacts
info {
...ContactInfoFragment
}
interactionsIsEngaged
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isActive
isArchived
isEmployee
isKeyContact
isPersonal
marketingListConsent {
...ContactConsentFragment
}
officeLocation {
...CompanyOfficeLocationFragment
}
primaryEmail
unarchiveOnNextInteraction
updatedAt
}
tags
title
trackingNumber
updatedAt
}
}
Variables
{"uid": "4"}
Response
{
"data": {
"opportunity": {
"archived": false,
"assignedTo": Employee,
"company": Company,
"contactLast": LastAts,
"createdAt": ISO8601DateTime,
"createdBy": User,
"customFields": [CustomField],
"customStatus": OpportunityTrackingCustomStatus,
"date": ISO8601Date,
"description": RichContent,
"documents": [DocumentFile],
"emailBody": RichContent,
"id": "4",
"includedLawyers": [Employee],
"keyContacts": [Contact],
"outcome": "LOST",
"project": Project,
"proposedFee": 123.45,
"proposedFeeAmount": Money,
"receivedReferral": false,
"referralSource": Contact,
"tags": ["xyz789"],
"title": "xyz789",
"trackingNumber": "xyz789",
"updatedAt": ISO8601DateTime
}
}
}
opportunityPipelineAggregates
Description
Pipeline metrics for an opportunities source, broken down by standard status.
Response
Returns a PipelineAggregates
Arguments
| Name | Description |
|---|---|
filtering - ColumnsFilteringInput
|
|
search - String
|
|
source - TableLikeSourceInput!
|
Example
Query
query OpportunityPipelineAggregates(
$filtering: ColumnsFilteringInput,
$search: String,
$source: TableLikeSourceInput!
) {
opportunityPipelineAggregates(
filtering: $filtering,
search: $search,
source: $source
) {
byStatus {
count
status
sum {
...MoneyFragment
}
}
totalCount
totalValue {
cents
currency {
...CurrencyFragment
}
format
}
}
}
Variables
{
"filtering": ColumnsFilteringInput,
"search": "abc123",
"source": TableLikeSourceInput
}
Response
{
"data": {
"opportunityPipelineAggregates": {
"byStatus": [StatusAggregate],
"totalCount": 123,
"totalValue": Money
}
}
}
opportunityStatusChange
Response
Returns an OpportunityStatusChange
Arguments
| Name | Description |
|---|---|
uid - ID!
|
Example
Query
query OpportunityStatusChange($uid: ID!) {
opportunityStatusChange(uid: $uid) {
createdAt
fromStatus {
id
name
outcome
position
startingStatus
}
id
opportunity {
archived
assignedTo {
...EmployeeFragment
}
company {
...CompanyFragment
}
contactLast {
...LastAtsFragment
}
createdAt
createdBy {
...UserFragment
}
customFields {
...CustomFieldFragment
}
customStatus {
...OpportunityTrackingCustomStatusFragment
}
date
description {
...RichContentFragment
}
documents {
... on DocumentFile {
...DocumentFileFragment
}
... on DocumentUrl {
...DocumentUrlFragment
}
}
emailBody {
...RichContentFragment
}
id
includedLawyers {
...EmployeeFragment
}
keyContacts {
...ContactFragment
}
outcome
project {
...ProjectFragment
}
proposedFee
proposedFeeAmount {
...MoneyFragment
}
receivedReferral
referralSource {
...ContactFragment
}
tags
title
trackingNumber
updatedAt
}
toStatus {
id
name
outcome
position
startingStatus
}
}
}
Variables
{"uid": "4"}
Response
{
"data": {
"opportunityStatusChange": {
"createdAt": "4",
"fromStatus": OpportunityTrackingCustomStatus,
"id": 4,
"opportunity": Opportunity,
"toStatus": OpportunityTrackingCustomStatus
}
}
}
personNotes
Response
Returns a CompanyNoteList!
Example
Query
query PersonNotes(
$page: Int,
$perPage: Int,
$personUid: String!
) {
personNotes(
page: $page,
perPage: $perPage,
personUid: $personUid
) {
entries {
access
company {
...CompanyFragment
}
contact {
...ContactFragment
}
content {
...RichContentFragment
}
createdAt
creator {
...UserFragment
}
creatorName
id
updatedAt
updater {
...UserFragment
}
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"page": 1,
"perPage": 10,
"personUid": "xyz789"
}
Response
{
"data": {
"personNotes": {
"entries": [CompanyNote],
"pageInfo": PagingInfo
}
}
}
reportedIncorrectCompanyInfos
Description
Returns incorrect company
Response
Returns a ReportedIncorrectCompanyInfoEntries
Arguments
| Name | Description |
|---|---|
createdAfter - ISO8601DateTime
|
|
page - Int
|
|
perPage - Int
|
Example
Query
query ReportedIncorrectCompanyInfos(
$createdAfter: ISO8601DateTime,
$page: Int,
$perPage: Int
) {
reportedIncorrectCompanyInfos(
createdAfter: $createdAfter,
page: $page,
perPage: $perPage
) {
entries {
comment
company {
...CompanyFragment
}
fields
id
reporter {
...UserFragment
}
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"createdAfter": ISO8601DateTime,
"page": 123,
"perPage": 987
}
Response
{
"data": {
"reportedIncorrectCompanyInfos": {
"entries": [ReportedIncorrectCompanyInfo],
"pageInfo": PagingInfo
}
}
}
reportedIncorrectInfos
Description
Contacts that have been reported to have incorrect info
Response
Returns a ReportedIncorrectInfoEntries!
Arguments
| Name | Description |
|---|---|
filter - ReportedIncorrectInfosFiltering
|
|
page - Int!
|
Default = 1 |
perPage - Int!
|
Default = 25 |
Example
Query
query ReportedIncorrectInfos(
$filter: ReportedIncorrectInfosFiltering,
$page: Int!,
$perPage: Int!
) {
reportedIncorrectInfos(
filter: $filter,
page: $page,
perPage: $perPage
) {
entries {
comment
contact {
...ContactFragment
}
fields
id
reporter {
...UserInfoFragment
}
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"filter": ReportedIncorrectInfosFiltering,
"page": 1,
"perPage": 25
}
Response
{
"data": {
"reportedIncorrectInfos": {
"entries": [ReportedIncorrectInfo],
"pageInfo": PagingInfo
}
}
}
sentReferrals
Response
Returns a SentReferralEntries!
Arguments
| Name | Description |
|---|---|
filter - SentReferralsFilterInput
|
Default = null |
page - Int
|
Default = 1 |
perPage - Int
|
Default = 10 |
Example
Query
query SentReferrals(
$filter: SentReferralsFilterInput,
$page: Int,
$perPage: Int
) {
sentReferrals(
filter: $filter,
page: $page,
perPage: $perPage
) {
entries {
clientCompany {
...CompanyFragment
}
clientContact {
...ContactFragment
}
createdAt
customFields {
...CustomFieldFragment
}
discardedAt
externalIdentifier
id
referredByEmployee {
...EmployeeFragment
}
resultStatus
sentAt
sentToContact {
...ContactFragment
}
typeOfLegalMatter
updatedAt
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{"filter": null, "page": 1, "perPage": 10}
Response
{
"data": {
"sentReferrals": {
"entries": [SentReferral],
"pageInfo": PagingInfo
}
}
}
users
Description
Return Users
Response
Returns a UserEntries!
Arguments
| Name | Description |
|---|---|
email - String
|
|
page - Int!
|
Default = 1 |
perPage - Int!
|
Default = 10 |
scope - UsersScope!
|
Default = ALL |
term - String
|
Search term |
Example
Query
query Users(
$email: String,
$page: Int!,
$perPage: Int!,
$scope: UsersScope!,
$term: String
) {
users(
email: $email,
page: $page,
perPage: $perPage,
scope: $scope,
term: $term
) {
adminEntries {
accessRole {
...AccessRoleFragment
}
archivedAt
canArchiveContactsAndCompanies
canUpdateCompanyName
canViewActivityViewDetail
canViewEmbeddedReport
delegateAccess
email
employee {
...EmployeeFragment
}
firstName
id
isActive
isSuperAdmin
lastLoginAt
lastName
profileImageUrl
profileName
role
userId
}
entries {
canArchiveContactsAndCompanies
canUpdateCompanyName
canViewActivityViewDetail
email
employee {
...EmployeeFragment
}
firstName
id
isActive
lastName
profileImageUrl
profileName
role
userId
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"email": "xyz789",
"page": 1,
"perPage": 10,
"scope": "ALL",
"term": "xyz789"
}
Response
{
"data": {
"users": {
"adminEntries": [User],
"entries": [UserInfo],
"pageInfo": PagingInfo
}
}
}
webhookEvents
Response
Returns a WebhookEventEntries!
Example
Query
query WebhookEvents(
$page: Int,
$perPage: Int
) {
webhookEvents(
page: $page,
perPage: $perPage
) {
entries {
destinationUrl
id
payload
triggerEvent
}
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{"page": 1, "perPage": 10}
Response
{
"data": {
"webhookEvents": {
"entries": [WebhookEvent],
"pageInfo": PagingInfo
}
}
}
whoKnows
Description
List of contact relationships
Response
Returns a WhoKnowsList!
Arguments
| Name | Description |
|---|---|
contactUid - String
|
Contact email or id |
filter - WhoKnowsFiltering
|
|
page - Int
|
Default = 1 |
perPage - Int
|
Default = 10 |
Example
Query
query WhoKnows(
$contactUid: String,
$filter: WhoKnowsFiltering,
$page: Int,
$perPage: Int
) {
whoKnows(
contactUid: $contactUid,
filter: $filter,
page: $page,
perPage: $perPage
) {
pageInfo {
totalEntries
totalPages
}
}
}
Variables
{
"contactUid": "abc123",
"filter": WhoKnowsFiltering,
"page": 1,
"perPage": 10
}
Response
{"data": {"whoKnows": {"pageInfo": PagingInfo}}}
Mutations
addCompanyKeyContact
Response
Returns a CreateCompanyKeyContactMutationPayload
Example
Query
mutation AddCompanyKeyContact(
$companyUid: String!,
$contactUid: String!
) {
addCompanyKeyContact(
companyUid: $companyUid,
contactUid: $contactUid
) {
failReasons
}
}
Variables
{
"companyUid": "abc123",
"contactUid": "xyz789"
}
Response
{
"data": {
"addCompanyKeyContact": {
"failReasons": ["abc123"]
}
}
}
addCompanyRelationshipPartner
Description
Create company relationship partner
Response
Example
Query
mutation AddCompanyRelationshipPartner(
$companyUid: String!,
$ownerUid: String!
) {
addCompanyRelationshipPartner(
companyUid: $companyUid,
ownerUid: $ownerUid
) {
failReasons
relationshipPartnerCreated {
company {
...CompanyFragment
}
discardedAt
employee {
...EmployeeFragment
}
id
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
}
}
}
Variables
{
"companyUid": "abc123",
"ownerUid": "xyz789"
}
Response
{
"data": {
"addCompanyRelationshipPartner": {
"failReasons": ["abc123"],
"relationshipPartnerCreated": RelationshipPartner
}
}
}
addCompanyTags
Description
Adds a tag to company
Response
Returns an AddCompanyTagsMutationPayload
Example
Query
mutation AddCompanyTags(
$companyUid: ID!,
$tags: String!
) {
addCompanyTags(
companyUid: $companyUid,
tags: $tags
) {
failReasons
}
}
Variables
{"companyUid": 4, "tags": "abc123"}
Response
{
"data": {
"addCompanyTags": {
"failReasons": ["abc123"]
}
}
}
addCompanyToHierarchy
Description
Add new company to company hierarchy
Response
Returns an AddCompanyToHierarchyMutationPayload
Example
Query
mutation AddCompanyToHierarchy(
$companyDomain: String,
$companyName: String!,
$parentUuid: ID!,
$position: Int
) {
addCompanyToHierarchy(
companyDomain: $companyDomain,
companyName: $companyName,
parentUuid: $parentUuid,
position: $position
) {
failReasons
}
}
Variables
{
"companyDomain": "xyz789",
"companyName": "xyz789",
"parentUuid": "4",
"position": 123
}
Response
{
"data": {
"addCompanyToHierarchy": {
"failReasons": ["xyz789"]
}
}
}
addContactTags
Description
Bulk add tags to contacts in list
Response
Returns an AddTagsToContactsMutationPayload
Example
Query
mutation AddContactTags(
$contactEmails: [String!],
$contactUidsString: String,
$tags: [String!],
$tagsString: String
) {
addContactTags(
contactEmails: $contactEmails,
contactUidsString: $contactUidsString,
tags: $tags,
tagsString: $tagsString
) {
contactCards {
archivedAt
company {
...CompanyGridFragment
}
companyCard {
...CompanyCardFragment
}
companyDetail {
...CompanyDetailFragment
}
companyExternalIdentifier {
...ExternalIdentifierFragment
}
companyKeyContactSince
companySwitchKnownDetail
contactId
contactLocation {
...LocationFragment
}
displayName
educations
firstName
id
imageUrl
isArchived
isBounced
isInteractionsEngaged
jobTitle
lastInteractionAt
lastName
linkedinUrl
phoneNumbers
primaryEmail
tags
twitterUrl
}
failReasons
}
}
Variables
{
"contactEmails": ["abc123"],
"contactUidsString": "abc123",
"tags": ["abc123"],
"tagsString": "abc123"
}
Response
{
"data": {
"addContactTags": {
"contactCards": [ContactCard],
"failReasons": ["xyz789"]
}
}
}
addCustomFieldSchemaOption
Response
Returns an AddOptionMutationPayload
Arguments
| Name | Description |
|---|---|
options - [OptionsAttributes!]
|
Default = [] |
schemaUuid - ID!
|
Example
Query
mutation AddCustomFieldSchemaOption(
$options: [OptionsAttributes!],
$schemaUuid: ID!
) {
addCustomFieldSchemaOption(
options: $options,
schemaUuid: $schemaUuid
) {
failReasons
}
}
Variables
{"options": [""], "schemaUuid": "4"}
Response
{
"data": {
"addCustomFieldSchemaOption": {
"failReasons": ["xyz789"]
}
}
}
addEmailMarketingCampaignRecipient
Description
Adds a recipient to a continuous email marketing campaign
Response
Returns an AddRecipientMutationPayload
Example
Query
mutation AddEmailMarketingCampaignRecipient(
$campaignUid: ID!,
$recipientEmail: String,
$recipientEmails: [String!]
) {
addEmailMarketingCampaignRecipient(
campaignUid: $campaignUid,
recipientEmail: $recipientEmail,
recipientEmails: $recipientEmails
) {
failReasons
}
}
Variables
{
"campaignUid": "4",
"recipientEmail": null,
"recipientEmails": [""]
}
Response
{
"data": {
"addEmailMarketingCampaignRecipient": {
"failReasons": ["abc123"]
}
}
}
addItemToGenericList
Response
Returns a CreateGenericListItemMutationPayload
Arguments
| Name | Description |
|---|---|
customFieldAttributes - [CustomFieldAttribute!]
|
|
genericListUid - ID!
|
Example
Query
mutation AddItemToGenericList(
$customFieldAttributes: [CustomFieldAttribute!],
$genericListUid: ID!
) {
addItemToGenericList(
customFieldAttributes: $customFieldAttributes,
genericListUid: $genericListUid
) {
failReasons
record {
completedTasksCount
createdAt
customFields {
...CustomFieldFragment
}
genericList {
...GenericListFragment
}
gridCustomFields {
...CustomFieldGridFragment
}
id
listReminders {
...ReminderFragment
}
tasksCount
updatedAt
}
}
}
Variables
{
"customFieldAttributes": [CustomFieldAttribute],
"genericListUid": 4
}
Response
{
"data": {
"addItemToGenericList": {
"failReasons": ["xyz789"],
"record": GenericListItem
}
}
}
addMemberToCompanyList
Description
Add company to list
Response
Returns an AddCompanyListMemberMutationPayload
Arguments
| Name | Description |
|---|---|
companyUid - ID!
|
|
customFields - [CustomFieldAttribute!]
|
|
listUid - ID!
|
Example
Query
mutation AddMemberToCompanyList(
$companyUid: ID!,
$customFields: [CustomFieldAttribute!],
$listUid: ID!
) {
addMemberToCompanyList(
companyUid: $companyUid,
customFields: $customFields,
listUid: $listUid
) {
failReasons
record {
company {
...CompanyFragment
}
companyList {
...CompanyListItemFragment
}
companyListId
completedTasksCount
customFields {
...CustomFieldFragment
}
gridCustomFields {
...CustomFieldGridFragment
}
id
listReminders {
...ReminderFragment
}
tasksCount
updatedAt
}
}
}
Variables
{
"companyUid": 4,
"customFields": [CustomFieldAttribute],
"listUid": 4
}
Response
{
"data": {
"addMemberToCompanyList": {
"failReasons": ["abc123"],
"record": CompanyListMember
}
}
}
addMemberToContactList
Description
Adds a contact to a list
Response
Returns an AddContactToListMutationPayload
Arguments
| Name | Description |
|---|---|
contactUid - String!
|
id or email of the contact |
customFields - [CustomFieldAttribute!]
|
|
listUid - ID!
|
|
upsert - Boolean!
|
if false, will not add contact if already in list. Default = true |
Example
Query
mutation AddMemberToContactList(
$contactUid: String!,
$customFields: [CustomFieldAttribute!],
$listUid: ID!,
$upsert: Boolean!
) {
addMemberToContactList(
contactUid: $contactUid,
customFields: $customFields,
listUid: $listUid,
upsert: $upsert
) {
failReasons
gridMemberRecord {
addedBy {
...UserCardFragment
}
completedTasksCount
contactCard {
...ContactCardFragment
}
contactCustomFields {
...CustomFieldGridFragment
}
contactId
contactInteractionsLast {
...LastAtsFragment
}
contactInteractionsTotal {
...TotalsFragment
}
createdAt
customFields {
...CustomFieldGridFragment
}
id
inMyContacts
listId
listReminders {
...ReminderFragment
}
marketingListContactConsent {
...ContactConsentFragment
}
officeLocation {
...LocationFragment
}
tasksCount
updatedAt
}
record {
completedTasksCount
contact {
...ContactFragment
}
createdAt
creator {
...UserFragment
}
customFields {
...CustomFieldFragment
}
discardedAt
id
listId
listReminders {
...ReminderFragment
}
myContact {
...MyContactFragment
}
remover {
...UserFragment
}
tasksCount
updatedAt
}
}
}
Variables
{
"contactUid": "xyz789",
"customFields": [CustomFieldAttribute],
"listUid": 4,
"upsert": true
}
Response
{
"data": {
"addMemberToContactList": {
"failReasons": ["abc123"],
"gridMemberRecord": ContactListGridMember,
"record": ListMember
}
}
}
addProjectMembers
Response
Returns an AddProjectMembersMutationPayload
Arguments
| Name | Description |
|---|---|
memberEmails - [String!]!
|
|
uuid - ID!
|
Project id |
Example
Query
mutation AddProjectMembers(
$memberEmails: [String!]!,
$uuid: ID!
) {
addProjectMembers(
memberEmails: $memberEmails,
uuid: $uuid
) {
failReasons
}
}
Variables
{"memberEmails": ["xyz789"], "uuid": 4}
Response
{
"data": {
"addProjectMembers": {
"failReasons": ["xyz789"]
}
}
}
archiveCompanyOpportunity
Description
Removes a goal
Response
Arguments
| Name | Description |
|---|---|
uuid - ID!
|
Example
Query
mutation ArchiveCompanyOpportunity($uuid: ID!) {
archiveCompanyOpportunity(uuid: $uuid) {
failReasons
}
}
Variables
{"uuid": "4"}
Response
{
"data": {
"archiveCompanyOpportunity": {
"failReasons": ["xyz789"]
}
}
}
archiveContact
Description
Archive contact
Response
Returns an ArchiveContactMutationPayload
Example
Query
mutation ArchiveContact(
$unarchiveOnInteraction: Boolean,
$uuid: ID!
) {
archiveContact(
unarchiveOnInteraction: $unarchiveOnInteraction,
uuid: $uuid
) {
contact {
archivedAt
changedJob
company {
...CompanyFragment
}
contactCompanySwitch {
...ContactCompanySwitchFragment
}
createdAt
emailAddresses
id
inMyContacts
info {
...ContactInfoFragment
}
interactionsIsEngaged
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isActive
isArchived
isEmployee
isKeyContact
isPersonal
marketingListConsent {
...ContactConsentFragment
}
officeLocation {
...CompanyOfficeLocationFragment
}
primaryEmail
unarchiveOnNextInteraction
updatedAt
}
failReasons
}
}
Variables
{"unarchiveOnInteraction": false, "uuid": 4}
Response
{
"data": {
"archiveContact": {
"contact": Contact,
"failReasons": ["abc123"]
}
}
}
archiveUser
Description
Archive's the user and prevents future logins
Response
Returns an ArchiveUserMutationPayload
Arguments
| Name | Description |
|---|---|
userUid - ID!
|
User ID or User Email |
Example
Query
mutation ArchiveUser($userUid: ID!) {
archiveUser(userUid: $userUid) {
failReasons
user {
accessRole {
...AccessRoleFragment
}
archivedAt
canArchiveContactsAndCompanies
canUpdateCompanyName
canViewActivityViewDetail
canViewEmbeddedReport
delegateAccess
email
employee {
...EmployeeFragment
}
firstName
id
isActive
isSuperAdmin
lastLoginAt
lastName
profileImageUrl
profileName
role
userId
}
}
}
Variables
{"userUid": 4}
Response
{
"data": {
"archiveUser": {
"failReasons": ["abc123"],
"user": User
}
}
}
blockDomain
Description
Block domain and any subdomains from recording interactions
Response
Returns a BlockDomainMutationPayload
Arguments
| Name | Description |
|---|---|
value - String!
|
Domain to block. It will autmatically block any subdomains as well |
Example
Query
mutation BlockDomain($value: String!) {
blockDomain(value: $value) {
failReasons
}
}
Variables
{"value": "xyz789"}
Response
{
"data": {
"blockDomain": {
"failReasons": ["xyz789"]
}
}
}
blockEmail
Description
Removes interactions with email and blocks future interactions with this email
Response
Returns a ClassifyEmailMutationPayload
Arguments
| Name | Description |
|---|---|
value - String!
|
Email to block |
Example
Query
mutation BlockEmail($value: String!) {
blockEmail(value: $value) {
failReasons
}
}
Variables
{"value": "abc123"}
Response
{
"data": {
"blockEmail": {
"failReasons": ["abc123"]
}
}
}
bulkUpdateListMember
Description
Bulk updates member's custom fields
Response
Returns a BulkUpdateListMemberMutationPayload
Arguments
| Name | Description |
|---|---|
customFieldAttributes - [CustomFieldAttribute!]!
|
|
listUid - ID
|
|
memberIds - [ID!]!
|
list member ids, or contact ids or contact emails |
Example
Query
mutation BulkUpdateListMember(
$customFieldAttributes: [CustomFieldAttribute!]!,
$listUid: ID,
$memberIds: [ID!]!
) {
bulkUpdateListMember(
customFieldAttributes: $customFieldAttributes,
listUid: $listUid,
memberIds: $memberIds
) {
failReasons
gridMemberRecords {
addedBy {
...UserCardFragment
}
completedTasksCount
contactCard {
...ContactCardFragment
}
contactCustomFields {
...CustomFieldGridFragment
}
contactId
contactInteractionsLast {
...LastAtsFragment
}
contactInteractionsTotal {
...TotalsFragment
}
createdAt
customFields {
...CustomFieldGridFragment
}
id
inMyContacts
listId
listReminders {
...ReminderFragment
}
marketingListContactConsent {
...ContactConsentFragment
}
officeLocation {
...LocationFragment
}
tasksCount
updatedAt
}
records {
completedTasksCount
contact {
...ContactFragment
}
createdAt
creator {
...UserFragment
}
customFields {
...CustomFieldFragment
}
discardedAt
id
listId
listReminders {
...ReminderFragment
}
myContact {
...MyContactFragment
}
remover {
...UserFragment
}
tasksCount
updatedAt
}
}
}
Variables
{
"customFieldAttributes": [CustomFieldAttribute],
"listUid": "4",
"memberIds": [4]
}
Response
{
"data": {
"bulkUpdateListMember": {
"failReasons": ["abc123"],
"gridMemberRecords": [ContactListGridMember],
"records": [ListMember]
}
}
}
clientSyncAddClientCompany
Description
Add a client company that will be synced to companies when sync completed
Response
Returns an AddClientCompanyForSyncMutationPayload
Example
Query
mutation ClientSyncAddClientCompany(
$clientIdentifier: String!,
$clientName: String!,
$domain: String,
$groupIdentifier: String!,
$groupName: String!
) {
clientSyncAddClientCompany(
clientIdentifier: $clientIdentifier,
clientName: $clientName,
domain: $domain,
groupIdentifier: $groupIdentifier,
groupName: $groupName
) {
failReasons
}
}
Variables
{
"clientIdentifier": "xyz789",
"clientName": "xyz789",
"domain": "xyz789",
"groupIdentifier": "abc123",
"groupName": "abc123"
}
Response
{
"data": {
"clientSyncAddClientCompany": {
"failReasons": ["xyz789"]
}
}
}
clientSyncAddClientCompanyAndSync
Description
Add a client company and sync the group it belongs to
Response
Returns a ReSyncClientCompanyMutationPayload
Example
Query
mutation ClientSyncAddClientCompanyAndSync(
$clientIdentifier: String!,
$clientName: String!,
$domain: String,
$groupIdentifier: String!,
$groupName: String!
) {
clientSyncAddClientCompanyAndSync(
clientIdentifier: $clientIdentifier,
clientName: $clientName,
domain: $domain,
groupIdentifier: $groupIdentifier,
groupName: $groupName
) {
failReasons
}
}
Variables
{
"clientIdentifier": "abc123",
"clientName": "abc123",
"domain": "xyz789",
"groupIdentifier": "abc123",
"groupName": "xyz789"
}
Response
{
"data": {
"clientSyncAddClientCompanyAndSync": {
"failReasons": ["xyz789"]
}
}
}
clientSyncCompleteSync
Description
Completes the sync of client companies to companies
Response
Example
Query
mutation ClientSyncCompleteSync {
clientSyncCompleteSync {
failReasons
}
}
Response
{
"data": {
"clientSyncCompleteSync": {
"failReasons": ["xyz789"]
}
}
}
clientSyncPrepareForSync
Description
Clears all previous sync data and prepares for a new sync
Response
Example
Query
mutation ClientSyncPrepareForSync {
clientSyncPrepareForSync {
failReasons
}
}
Response
{
"data": {
"clientSyncPrepareForSync": {
"failReasons": ["abc123"]
}
}
}
completeMyTask
Description
Complete my task
Response
Returns a CompleteMyTaskMutationPayload
Arguments
| Name | Description |
|---|---|
uid - ID!
|
Example
Query
mutation CompleteMyTask($uid: ID!) {
completeMyTask(uid: $uid) {
failReasons
}
}
Variables
{"uid": "4"}
Response
{
"data": {
"completeMyTask": {
"failReasons": ["abc123"]
}
}
}
createCompany
Description
Create company
Response
Returns a CreateCompanyMutationPayload
Arguments
| Name | Description |
|---|---|
additionalDomains - [String!]
|
|
assignedTo - String
|
owner employee email |
attributes - CompanyAttributes
|
|
companyDefaultType - CompanyTypeDefault
|
company default type |
companyTypeUid - ID
|
company type uid |
companyTypesUids - [ID!]
|
company types id or name |
domain - String!
|
|
externalIdentifier - ExternalIdentifierInput
|
|
secondaryCompanyTypeUids - [ID!]
|
secondary company type id or name |
Example
Query
mutation CreateCompany(
$additionalDomains: [String!],
$assignedTo: String,
$attributes: CompanyAttributes,
$companyDefaultType: CompanyTypeDefault,
$companyTypeUid: ID,
$companyTypesUids: [ID!],
$domain: String!,
$externalIdentifier: ExternalIdentifierInput,
$secondaryCompanyTypeUids: [ID!]
) {
createCompany(
additionalDomains: $additionalDomains,
assignedTo: $assignedTo,
attributes: $attributes,
companyDefaultType: $companyDefaultType,
companyTypeUid: $companyTypeUid,
companyTypesUids: $companyTypesUids,
domain: $domain,
externalIdentifier: $externalIdentifier,
secondaryCompanyTypeUids: $secondaryCompanyTypeUids
) {
failReasons
uid
}
}
Variables
{
"additionalDomains": ["abc123"],
"assignedTo": "xyz789",
"attributes": CompanyAttributes,
"companyDefaultType": "CLIENT",
"companyTypeUid": 4,
"companyTypesUids": ["4"],
"domain": "abc123",
"externalIdentifier": ExternalIdentifierInput,
"secondaryCompanyTypeUids": [4]
}
Response
{
"data": {
"createCompany": {
"failReasons": ["xyz789"],
"uid": 4
}
}
}
createCompanyContact
Description
Add contact to a company
Response
Returns a CreateCompanyContactMutationPayload
Example
Query
mutation CreateCompanyContact(
$companyId: ID!,
$email: String,
$linkedinUrl: String
) {
createCompanyContact(
companyId: $companyId,
email: $email,
linkedinUrl: $linkedinUrl
) {
failReasons
uid
}
}
Variables
{
"companyId": 4,
"email": "abc123",
"linkedinUrl": "abc123"
}
Response
{
"data": {
"createCompanyContact": {
"failReasons": ["xyz789"],
"uid": "4"
}
}
}
createCompanyListCustomFieldSchema
Response
Arguments
| Name | Description |
|---|---|
companyListUuid - ID!
|
|
customFieldAttributes - CustomFieldSchemaAttributes!
|
Example
Query
mutation CreateCompanyListCustomFieldSchema(
$companyListUuid: ID!,
$customFieldAttributes: CustomFieldSchemaAttributes!
) {
createCompanyListCustomFieldSchema(
companyListUuid: $companyListUuid,
customFieldAttributes: $customFieldAttributes
) {
failReasons
record {
campaigns {
...CampaignFragment
}
creator {
...UserInfoFragment
}
currency {
...CurrencyFragment
}
hideFromForm
id
name
optionChoices {
...OptionChoiceFragment
}
position
schemaId
searchable
sortChoicesAlphabetically
usage
valueTypeEnum
}
}
}
Variables
{
"companyListUuid": 4,
"customFieldAttributes": CustomFieldSchemaAttributes
}
Response
{
"data": {
"createCompanyListCustomFieldSchema": {
"failReasons": ["xyz789"],
"record": CustomFieldSchema
}
}
}
createCompanyNote
Description
Create a company note
Response
Returns a CreateCompanyNoteMutationPayload
Arguments
| Name | Description |
|---|---|
access - CompanyNoteAccess
|
|
companyUid - ID!
|
|
contactUid - ID
|
Default = null |
content - String!
|
Example
Query
mutation CreateCompanyNote(
$access: CompanyNoteAccess,
$companyUid: ID!,
$contactUid: ID,
$content: String!
) {
createCompanyNote(
access: $access,
companyUid: $companyUid,
contactUid: $contactUid,
content: $content
) {
failReasons
id
}
}
Variables
{
"access": "CUSTOM",
"companyUid": 4,
"contactUid": null,
"content": "xyz789"
}
Response
{
"data": {
"createCompanyNote": {
"failReasons": ["abc123"],
"id": "4"
}
}
}
createCompanyOfficeLocation
Description
Create company location
Response
Returns a CreateOfficeLocationMutationPayload
Arguments
| Name | Description |
|---|---|
companyId - ID!
|
|
headquarterLocation - Boolean
|
|
labels - [String!]
|
|
locationAttributes - LocationAttributes!
|
|
primaryLocation - Boolean
|
Example
Query
mutation CreateCompanyOfficeLocation(
$companyId: ID!,
$headquarterLocation: Boolean,
$labels: [String!],
$locationAttributes: LocationAttributes!,
$primaryLocation: Boolean
) {
createCompanyOfficeLocation(
companyId: $companyId,
headquarterLocation: $headquarterLocation,
labels: $labels,
locationAttributes: $locationAttributes,
primaryLocation: $primaryLocation
) {
failReasons
}
}
Variables
{
"companyId": 4,
"headquarterLocation": true,
"labels": ["abc123"],
"locationAttributes": LocationAttributes,
"primaryLocation": false
}
Response
{
"data": {
"createCompanyOfficeLocation": {
"failReasons": ["abc123"]
}
}
}
createCompanyOpportunity
Description
Create company opportunity
Response
Returns an OpportunityTrackingCreateOpportunityMutationPayload
Arguments
| Name | Description |
|---|---|
attributes - CompanyGoalAttributes!
|
Default = {receivedReferral: false} |
companyUid - ID!
|
|
customStatusUid - ID
|
Status Name or Status id |
Example
Query
mutation CreateCompanyOpportunity(
$attributes: CompanyGoalAttributes!,
$companyUid: ID!,
$customStatusUid: ID
) {
createCompanyOpportunity(
attributes: $attributes,
companyUid: $companyUid,
customStatusUid: $customStatusUid
) {
failReasons
gridRecord {
assignedTo {
...EmployeeGridFragment
}
commsLast {
...LastAtsFragment
}
company {
...CompanyGridFragment
}
createdAt
createdBy {
...UserGridFragment
}
customFields {
...CustomFieldGridFragment
}
customStatus {
...OpportunityTrackingCustomStatusFragment
}
date
id
keyContacts {
...ContactGridFragment
}
othersIncluded {
...EmployeeGridFragment
}
proposedFeeAmount {
...MoneyFragment
}
referralSource {
...ContactGridFragment
}
tags
title
trackingNumber
updatedAt
}
record {
archived
assignedTo {
...EmployeeFragment
}
company {
...CompanyFragment
}
contactLast {
...LastAtsFragment
}
createdAt
createdBy {
...UserFragment
}
customFields {
...CustomFieldFragment
}
customStatus {
...OpportunityTrackingCustomStatusFragment
}
date
description {
...RichContentFragment
}
documents {
... on DocumentFile {
...DocumentFileFragment
}
... on DocumentUrl {
...DocumentUrlFragment
}
}
emailBody {
...RichContentFragment
}
id
includedLawyers {
...EmployeeFragment
}
keyContacts {
...ContactFragment
}
outcome
project {
...ProjectFragment
}
proposedFee
proposedFeeAmount {
...MoneyFragment
}
receivedReferral
referralSource {
...ContactFragment
}
tags
title
trackingNumber
updatedAt
}
uid
}
}
Variables
{
"attributes": {"receivedReferral": "false"},
"companyUid": "4",
"customStatusUid": 4
}
Response
{
"data": {
"createCompanyOpportunity": {
"failReasons": ["abc123"],
"gridRecord": OpportunityGrid,
"record": CompanyGoal,
"uid": 4
}
}
}
createContact
Description
Create a contact or activate an archived contact
Response
Returns a CreateContactMutationPayload
Arguments
| Name | Description |
|---|---|
attributes - ContactAttributes
|
|
email - String!
|
Example
Query
mutation CreateContact(
$attributes: ContactAttributes,
$email: String!
) {
createContact(
attributes: $attributes,
email: $email
) {
failReasons
record {
archivedAt
changedJob
company {
...CompanyFragment
}
contactCompanySwitch {
...ContactCompanySwitchFragment
}
createdAt
emailAddresses
id
inMyContacts
info {
...ContactInfoFragment
}
interactionsIsEngaged
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isActive
isArchived
isEmployee
isKeyContact
isPersonal
marketingListConsent {
...ContactConsentFragment
}
officeLocation {
...CompanyOfficeLocationFragment
}
primaryEmail
unarchiveOnNextInteraction
updatedAt
}
uid
}
}
Variables
{
"attributes": ContactAttributes,
"email": "abc123"
}
Response
{
"data": {
"createContact": {
"failReasons": ["abc123"],
"record": Contact,
"uid": "4"
}
}
}
createContactListCustomFieldSchema
Response
Arguments
| Name | Description |
|---|---|
customFieldAttributes - CustomFieldSchemaAttributes!
|
|
listUuid - ID!
|
Example
Query
mutation CreateContactListCustomFieldSchema(
$customFieldAttributes: CustomFieldSchemaAttributes!,
$listUuid: ID!
) {
createContactListCustomFieldSchema(
customFieldAttributes: $customFieldAttributes,
listUuid: $listUuid
) {
failReasons
record {
campaigns {
...CampaignFragment
}
creator {
...UserInfoFragment
}
currency {
...CurrencyFragment
}
hideFromForm
id
name
optionChoices {
...OptionChoiceFragment
}
position
schemaId
searchable
sortChoicesAlphabetically
usage
valueTypeEnum
}
}
}
Variables
{
"customFieldAttributes": CustomFieldSchemaAttributes,
"listUuid": 4
}
Response
{
"data": {
"createContactListCustomFieldSchema": {
"failReasons": ["abc123"],
"record": CustomFieldSchema
}
}
}
createContactListWebhook
Description
Add a contact list webhook
Response
Returns a CreateContactListWebhookMutationPayload
Arguments
| Name | Description |
|---|---|
destinationUrl - String!
|
|
externalIdentifier - ID
|
|
fragmentFields - String!
|
|
listUid - String!
|
|
triggerEvent - WebhookTriggerEvent!
|
Example
Query
mutation CreateContactListWebhook(
$destinationUrl: String!,
$externalIdentifier: ID,
$fragmentFields: String!,
$listUid: String!,
$triggerEvent: WebhookTriggerEvent!
) {
createContactListWebhook(
destinationUrl: $destinationUrl,
externalIdentifier: $externalIdentifier,
fragmentFields: $fragmentFields,
listUid: $listUid,
triggerEvent: $triggerEvent
) {
failReasons
record {
id
}
}
}
Variables
{
"destinationUrl": "abc123",
"externalIdentifier": 4,
"fragmentFields": "xyz789",
"listUid": "xyz789",
"triggerEvent": "GENERIC_LISTS_ITEM_CREATED"
}
Response
{
"data": {
"createContactListWebhook": {
"failReasons": ["abc123"],
"record": WebhookTrigger
}
}
}
createEmailMarketingCampaign
Response
Returns a CreateCampaignMutationPayload
Arguments
| Name | Description |
|---|---|
title - String!
|
Example
Query
mutation CreateEmailMarketingCampaign($title: String!) {
createEmailMarketingCampaign(title: $title) {
campaign {
allowContinuousResend
analytics {
...CampaignAnalyticsFragment
}
attachment {
...FileFragment
}
clickTracking
continuous
createdAt
createdBy {
...UserFragment
}
fromEmail
id
openTracking
project {
...ProjectFragment
}
projectUrl
recipientList {
...ListFragment
}
recipientListFilter {
...CampaignRecipientListFilterFragment
}
scheduledAt
sender {
...SenderFragment
}
sentAt
status
subject
templateHtml
templateJson
title
updatedAt
usageMode
}
failReasons
}
}
Variables
{"title": "abc123"}
Response
{
"data": {
"createEmailMarketingCampaign": {
"campaign": Campaign,
"failReasons": ["xyz789"]
}
}
}
createEmbedUrlTab
Description
Create embed url tab
Response
Returns a CreateEmbedUrlTabMutationPayload
Example
Query
mutation CreateEmbedUrlTab(
$group: String!,
$name: String!,
$position: Int!,
$url: String!
) {
createEmbedUrlTab(
group: $group,
name: $name,
position: $position,
url: $url
) {
failReasons
id
}
}
Variables
{
"group": "xyz789",
"name": "xyz789",
"position": 987,
"url": "abc123"
}
Response
{
"data": {
"createEmbedUrlTab": {
"failReasons": ["abc123"],
"id": 4
}
}
}
createGenericListWebhook
Description
Add a generic list webhook
Response
Returns a CreateGenericListWebhookMutationPayload
Arguments
| Name | Description |
|---|---|
destinationUrl - String!
|
|
externalIdentifier - ID
|
|
fragmentFields - String!
|
|
listUid - String!
|
|
triggerEvent - WebhookTriggerEvent!
|
Example
Query
mutation CreateGenericListWebhook(
$destinationUrl: String!,
$externalIdentifier: ID,
$fragmentFields: String!,
$listUid: String!,
$triggerEvent: WebhookTriggerEvent!
) {
createGenericListWebhook(
destinationUrl: $destinationUrl,
externalIdentifier: $externalIdentifier,
fragmentFields: $fragmentFields,
listUid: $listUid,
triggerEvent: $triggerEvent
) {
failReasons
record {
id
}
}
}
Variables
{
"destinationUrl": "abc123",
"externalIdentifier": 4,
"fragmentFields": "abc123",
"listUid": "xyz789",
"triggerEvent": "GENERIC_LISTS_ITEM_CREATED"
}
Response
{
"data": {
"createGenericListWebhook": {
"failReasons": ["abc123"],
"record": WebhookTrigger
}
}
}
createInternalIndustry
Description
create internal industry
Response
Returns a CreateInternalIndustryMutationPayload
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
mutation CreateInternalIndustry($name: String!) {
createInternalIndustry(name: $name) {
failReasons
id
}
}
Variables
{"name": "xyz789"}
Response
{
"data": {
"createInternalIndustry": {
"failReasons": ["xyz789"],
"id": "4"
}
}
}
createKeyActivities
Description
Create key activities in bulk
Response
Returns a CreateKeyActivitiesMutationPayload
Arguments
| Name | Description |
|---|---|
keyActivityBatchItems - [KeyActivityBatchItemInput!]!
|
Example
Query
mutation CreateKeyActivities($keyActivityBatchItems: [KeyActivityBatchItemInput!]!) {
createKeyActivities(keyActivityBatchItems: $keyActivityBatchItems) {
failReasons
}
}
Variables
{"keyActivityBatchItems": [KeyActivityBatchItemInput]}
Response
{
"data": {
"createKeyActivities": {
"failReasons": ["abc123"]
}
}
}
createKeyActivity
Response
Returns a MarkKeyActivityMutationPayload
Arguments
| Name | Description |
|---|---|
activityTitle - String!
|
|
companies - [ID!]
|
|
description - String
|
|
externalContacts - [String!]
|
email address or contact id |
interactionEndAt - ISO8601DateTime
|
|
interactionOn - ISO8601DateTime!
|
|
internalContacts - [String!]
|
|
keyActivityCategory - KeyActivityCategory!
|
|
keyActivityListUid - ID
|
|
notes - String
|
|
sourceReferenceId - String
|
Example
Query
mutation CreateKeyActivity(
$activityTitle: String!,
$companies: [ID!],
$description: String,
$externalContacts: [String!],
$interactionEndAt: ISO8601DateTime,
$interactionOn: ISO8601DateTime!,
$internalContacts: [String!],
$keyActivityCategory: KeyActivityCategory!,
$keyActivityListUid: ID,
$notes: String,
$sourceReferenceId: String
) {
createKeyActivity(
activityTitle: $activityTitle,
companies: $companies,
description: $description,
externalContacts: $externalContacts,
interactionEndAt: $interactionEndAt,
interactionOn: $interactionOn,
internalContacts: $internalContacts,
keyActivityCategory: $keyActivityCategory,
keyActivityListUid: $keyActivityListUid,
notes: $notes,
sourceReferenceId: $sourceReferenceId
) {
failReasons
keyActitivityListMember {
customFields {
...CustomFieldFragment
}
id
isPersisted
keyActivity {
...KeyActivityFragment
}
list {
...KeyActivityListFragment
}
}
keyActivity {
activityTitle
calendarMeeting {
...EmployeeMeetingFragment
}
category
contactsInvolved {
...ContactFragment
}
description
id
interaction {
...PartitionedInteractionFragment
}
interactionEndAt
interactionOn
involvedCompanies {
...CompanyFragment
}
involvedContacts {
...ContactFragment
}
keyActivityListMember {
...KeyActivityListMemberFragment
}
notes {
...RichContentFragment
}
sourceReferenceId
staffInvolved {
...EmployeeFragment
}
}
}
}
Variables
{
"activityTitle": "xyz789",
"companies": [4],
"description": "abc123",
"externalContacts": ["abc123"],
"interactionEndAt": ISO8601DateTime,
"interactionOn": ISO8601DateTime,
"internalContacts": ["xyz789"],
"keyActivityCategory": "BUSINESS_DEVELOPMENT",
"keyActivityListUid": 4,
"notes": "abc123",
"sourceReferenceId": "xyz789"
}
Response
{
"data": {
"createKeyActivity": {
"failReasons": ["xyz789"],
"keyActitivityListMember": KeyActivityListMember,
"keyActivity": KeyActivity
}
}
}
createMarketingContactList
Description
Create a marketing contact list
Response
Arguments
| Name | Description |
|---|---|
category - ListCategory
|
|
listType - ListType
|
Default = STATIC |
name - String!
|
Example
Query
mutation CreateMarketingContactList(
$category: ListCategory,
$listType: ListType,
$name: String!
) {
createMarketingContactList(
category: $category,
listType: $listType,
name: $name
) {
failReasons
record {
allowDuplicates
category
clean {
...CleanFragment
}
contactsCount
createdAt
creator {
...UserFragment
}
discardedAt
filterCriteria
id
listType
memberCustomFields {
...CustomFieldSchemaFragment
}
name
reminderSettings {
...ReminderSettingFragment
}
renderMode
searchTerm
tabUid
updatedAt
}
}
}
Variables
{
"category": "CLIENT_ALERT",
"listType": "STATIC",
"name": "xyz789"
}
Response
{
"data": {
"createMarketingContactList": {
"failReasons": ["abc123"],
"record": List
}
}
}
createProject
Response
Returns a CreateProjectMutationPayload
Arguments
| Name | Description |
|---|---|
attributes - ProjectAttribute!
|
Example
Query
mutation CreateProject($attributes: ProjectAttribute!) {
createProject(attributes: $attributes) {
failReasons
record {
colorCode
createdAt
createdBy {
...EmployeeFragment
}
description {
...RichContentFragment
}
discardedAt
documents {
...ProjectDocumentFragment
}
firmWide
folder {
...FolderFragment
}
iconCode
id
nexlApps
objectives {
...ObjectiveFragment
}
opportunityCustomFieldSchemas {
...CustomFieldSchemaFragment
}
overviewTab {
...ProjectOverviewTabFragment
}
readOnly
tabGroupName
tabs {
...TabResultFragment
}
teamMembersCount
title
updatedAt
}
}
}
Variables
{"attributes": ProjectAttribute}
Response
{
"data": {
"createProject": {
"failReasons": ["xyz789"],
"record": Project
}
}
}
createProjectFromTemplate
Response
Returns a CreateProjectFromTemplateMutationPayload
Arguments
| Name | Description |
|---|---|
templateProjectId - ID!
|
Example
Query
mutation CreateProjectFromTemplate($templateProjectId: ID!) {
createProjectFromTemplate(templateProjectId: $templateProjectId) {
failReasons
record {
colorCode
createdAt
createdBy {
...EmployeeFragment
}
description {
...RichContentFragment
}
discardedAt
documents {
...ProjectDocumentFragment
}
firmWide
folder {
...FolderFragment
}
iconCode
id
nexlApps
objectives {
...ObjectiveFragment
}
opportunityCustomFieldSchemas {
...CustomFieldSchemaFragment
}
overviewTab {
...ProjectOverviewTabFragment
}
readOnly
tabGroupName
tabs {
...TabResultFragment
}
teamMembersCount
title
updatedAt
}
}
}
Variables
{"templateProjectId": 4}
Response
{
"data": {
"createProjectFromTemplate": {
"failReasons": ["xyz789"],
"record": Project
}
}
}
createSentReferral
Response
Returns a CreateSentReferralMutationPayload
Arguments
| Name | Description |
|---|---|
clientCompanyUid - ID
|
|
clientContactUid - ID
|
|
customFieldAttributes - [CustomFieldAttribute!]
|
|
externalIdentifier - String
|
|
referredByEmployeeUid - ID!
|
|
resultStatus - SentReferralResultStatus
|
|
sentAt - ISO8601DateTime!
|
|
sentToContactUid - ID!
|
|
typeOfLegalMatter - String
|
Example
Query
mutation CreateSentReferral(
$clientCompanyUid: ID,
$clientContactUid: ID,
$customFieldAttributes: [CustomFieldAttribute!],
$externalIdentifier: String,
$referredByEmployeeUid: ID!,
$resultStatus: SentReferralResultStatus,
$sentAt: ISO8601DateTime!,
$sentToContactUid: ID!,
$typeOfLegalMatter: String
) {
createSentReferral(
clientCompanyUid: $clientCompanyUid,
clientContactUid: $clientContactUid,
customFieldAttributes: $customFieldAttributes,
externalIdentifier: $externalIdentifier,
referredByEmployeeUid: $referredByEmployeeUid,
resultStatus: $resultStatus,
sentAt: $sentAt,
sentToContactUid: $sentToContactUid,
typeOfLegalMatter: $typeOfLegalMatter
) {
failReasons
record {
clientCompany {
...CompanyFragment
}
clientContact {
...ContactFragment
}
createdAt
customFields {
...CustomFieldFragment
}
discardedAt
externalIdentifier
id
referredByEmployee {
...EmployeeFragment
}
resultStatus
sentAt
sentToContact {
...ContactFragment
}
typeOfLegalMatter
updatedAt
}
}
}
Variables
{
"clientCompanyUid": 4,
"clientContactUid": 4,
"customFieldAttributes": [CustomFieldAttribute],
"externalIdentifier": "xyz789",
"referredByEmployeeUid": 4,
"resultStatus": "SENT",
"sentAt": ISO8601DateTime,
"sentToContactUid": 4,
"typeOfLegalMatter": "abc123"
}
Response
{
"data": {
"createSentReferral": {
"failReasons": ["abc123"],
"record": SentReferral
}
}
}
createStaticCompanyListTab
Description
Create a static company list tab
Response
Arguments
| Name | Description |
|---|---|
companyListAttributes - CompanyListAttributes
|
|
group - String!
|
|
name - String!
|
|
ownedBy - OwnedByInput
|
|
position - Int!
|
|
projectUid - ID
|
Deprecated: Use ownedBy instead |
usageMode - CompanyUsageModeInput!
|
Example
Query
mutation CreateStaticCompanyListTab(
$companyListAttributes: CompanyListAttributes,
$group: String!,
$name: String!,
$ownedBy: OwnedByInput,
$position: Int!,
$projectUid: ID,
$usageMode: CompanyUsageModeInput!
) {
createStaticCompanyListTab(
companyListAttributes: $companyListAttributes,
group: $group,
name: $name,
ownedBy: $ownedBy,
position: $position,
projectUid: $projectUid,
usageMode: $usageMode
) {
failReasons
id
record {
discardedAt
id
isAppTab
isWorkspaceTab
name
pageResult {
... on BlockPageList {
...BlockPageListFragment
}
... on Campaign {
...CampaignFragment
}
... on CompanyListItem {
...CompanyListItemFragment
}
... on CustomObjectsRecordList {
...CustomObjectsRecordListFragment
}
... on EmbedUrl {
...EmbedUrlFragment
}
... on GenericList {
...GenericListFragment
}
... on KeyActivityList {
...KeyActivityListFragment
}
... on List {
...ListFragment
}
... on PreferenceField {
...PreferenceFieldFragment
}
... on SaveView {
...SaveViewFragment
}
}
position
renderMode
}
}
}
Variables
{
"companyListAttributes": CompanyListAttributes,
"group": "xyz789",
"name": "abc123",
"ownedBy": OwnedByInput,
"position": 123,
"projectUid": 4,
"usageMode": "PERSONAL"
}
Response
{
"data": {
"createStaticCompanyListTab": {
"failReasons": ["xyz789"],
"id": "4",
"record": TabResult
}
}
}
createTask
Description
Create a task
Response
Returns a CreateTaskMutationPayload
Example
Query
mutation CreateTask(
$assignedToUid: ID,
$attributes: CreateTaskAttributes!,
$companyListMemberUid: ID,
$companyUid: ID,
$contactListMemberUid: ID,
$contactUid: ID,
$genericListMemberUid: ID,
$projectTaskSectionUid: ID,
$projectUid: ID,
$requestedByUid: ID
) {
createTask(
assignedToUid: $assignedToUid,
attributes: $attributes,
companyListMemberUid: $companyListMemberUid,
companyUid: $companyUid,
contactListMemberUid: $contactListMemberUid,
contactUid: $contactUid,
genericListMemberUid: $genericListMemberUid,
projectTaskSectionUid: $projectTaskSectionUid,
projectUid: $projectUid,
requestedByUid: $requestedByUid
) {
failReasons
record {
assignedTo {
...EmployeeFragment
}
company {
...CompanyFragment
}
companyListMember {
...CompanyListMemberFragment
}
completedAt
completer {
...UserInfoFragment
}
contact {
...ContactFragment
}
contactListMember {
...ContactListGridMemberFragment
}
createdAt
createdBy {
...EmployeeFragment
}
description {
...RichContentFragment
}
dueOn
genericListMember {
...GenericListItemFragment
}
id
position
priority
project {
...ProjectFragment
}
projectTaskSection {
...ProjectTaskSectionFragment
}
requestedBy {
...EmployeeFragment
}
title
updatedAt
}
}
}
Variables
{
"assignedToUid": 4,
"attributes": CreateTaskAttributes,
"companyListMemberUid": 4,
"companyUid": "4",
"contactListMemberUid": "4",
"contactUid": 4,
"genericListMemberUid": 4,
"projectTaskSectionUid": "4",
"projectUid": "4",
"requestedByUid": "4"
}
Response
{
"data": {
"createTask": {
"failReasons": ["abc123"],
"record": Task
}
}
}
createUserDelegateAccess
Description
Create user delegate access for two user uids
Response
Returns a CreateUserDelegateAccessMutationPayload
Example
Query
mutation CreateUserDelegateAccess(
$delegateUserUid: ID!,
$userUid: ID!
) {
createUserDelegateAccess(
delegateUserUid: $delegateUserUid,
userUid: $userUid
) {
failReasons
}
}
Variables
{"delegateUserUid": 4, "userUid": "4"}
Response
{
"data": {
"createUserDelegateAccess": {
"failReasons": ["abc123"]
}
}
}
createWebhook
Description
Add a webhook
Response
Returns a CreateWebhookMutationPayload
Arguments
| Name | Description |
|---|---|
destinationUrl - String!
|
|
externalIdentifier - ID
|
|
fragmentFields - String!
|
|
triggerEvent - WebhookTriggerEvent!
|
Example
Query
mutation CreateWebhook(
$destinationUrl: String!,
$externalIdentifier: ID,
$fragmentFields: String!,
$triggerEvent: WebhookTriggerEvent!
) {
createWebhook(
destinationUrl: $destinationUrl,
externalIdentifier: $externalIdentifier,
fragmentFields: $fragmentFields,
triggerEvent: $triggerEvent
) {
failReasons
record {
id
}
}
}
Variables
{
"destinationUrl": "xyz789",
"externalIdentifier": 4,
"fragmentFields": "abc123",
"triggerEvent": "GENERIC_LISTS_ITEM_CREATED"
}
Response
{
"data": {
"createWebhook": {
"failReasons": ["xyz789"],
"record": WebhookTrigger
}
}
}
deleteMyTask
Description
Delete my task
Response
Returns a DeleteMyTaskMutationPayload
Arguments
| Name | Description |
|---|---|
taskUid - ID!
|
Example
Query
mutation DeleteMyTask($taskUid: ID!) {
deleteMyTask(taskUid: $taskUid) {
failReasons
task {
assignees {
...EmployeeFragment
}
completedAt
createdAt
description {
...RichContentFragment
}
dueOn
id
requestor {
...EmployeeFragment
}
source {
...MyTaskSourceFragment
}
title
updatedAt
}
}
}
Variables
{"taskUid": 4}
Response
{
"data": {
"deleteMyTask": {
"failReasons": ["xyz789"],
"task": MyTask
}
}
}
deleteSentReferral
Response
Returns a DeleteSentReferralMutationPayload
Arguments
| Name | Description |
|---|---|
sentReferralUid - ID!
|
Example
Query
mutation DeleteSentReferral($sentReferralUid: ID!) {
deleteSentReferral(sentReferralUid: $sentReferralUid) {
failReasons
}
}
Variables
{"sentReferralUid": "4"}
Response
{
"data": {
"deleteSentReferral": {
"failReasons": ["xyz789"]
}
}
}
deleteUserDelegateAccess
Description
Deletes user delegate access
Response
Returns a DeleteUserDelegateAccessMutationPayload
Example
Query
mutation DeleteUserDelegateAccess(
$delegateUserUid: ID!,
$userUid: ID!
) {
deleteUserDelegateAccess(
delegateUserUid: $delegateUserUid,
userUid: $userUid
) {
failReasons
}
}
Variables
{"delegateUserUid": 4, "userUid": "4"}
Response
{
"data": {
"deleteUserDelegateAccess": {
"failReasons": ["xyz789"]
}
}
}
hideEmployee
Description
Hide Employee from drop down selections and optional archive the contact as well
Response
Returns a HideEmployeeMutationPayload
Example
Query
mutation HideEmployee(
$andArchiveContact: Boolean,
$uid: String!
) {
hideEmployee(
andArchiveContact: $andArchiveContact,
uid: $uid
) {
failReasons
}
}
Variables
{"andArchiveContact": true, "uid": "xyz789"}
Response
{
"data": {
"hideEmployee": {
"failReasons": ["abc123"]
}
}
}
linkOpportunityToProjects
Description
Link Projects to opportunity
Response
Returns a LinkProjectsToOpportunityMutationPayload
Example
Query
mutation LinkOpportunityToProjects(
$opportunityUuid: ID!,
$projectUuids: [ID!]!
) {
linkOpportunityToProjects(
opportunityUuid: $opportunityUuid,
projectUuids: $projectUuids
) {
failReasons
}
}
Variables
{
"opportunityUuid": 4,
"projectUuids": ["4"]
}
Response
{
"data": {
"linkOpportunityToProjects": {
"failReasons": ["abc123"]
}
}
}
purgeContact
Description
Removes email addresses, activities history and audit trail from contact
Response
Returns a PurgeContactMutationPayload
Example
Query
mutation PurgeContact(
$contactUid: ID!,
$reason: String!
) {
purgeContact(
contactUid: $contactUid,
reason: $reason
) {
failReasons
}
}
Variables
{
"contactUid": "4",
"reason": "xyz789"
}
Response
{
"data": {
"purgeContact": {
"failReasons": ["xyz789"]
}
}
}
removeCompanyOfficeLocation
Description
Remove company location
Response
Returns a RemoveOfficeLocationMutationPayload
Arguments
| Name | Description |
|---|---|
companyOfficeLocationId - ID!
|
Example
Query
mutation RemoveCompanyOfficeLocation($companyOfficeLocationId: ID!) {
removeCompanyOfficeLocation(companyOfficeLocationId: $companyOfficeLocationId) {
failReasons
}
}
Variables
{"companyOfficeLocationId": 4}
Response
{
"data": {
"removeCompanyOfficeLocation": {
"failReasons": ["xyz789"]
}
}
}
removeCompanyRelationshipPartner
Description
Remove company relationship partner
Response
Example
Query
mutation RemoveCompanyRelationshipPartner(
$companyUid: String!,
$ownerUid: String!
) {
removeCompanyRelationshipPartner(
companyUid: $companyUid,
ownerUid: $ownerUid
) {
discarded {
company {
...CompanyFragment
}
discardedAt
employee {
...EmployeeFragment
}
id
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
}
failReasons
}
}
Variables
{
"companyUid": "xyz789",
"ownerUid": "xyz789"
}
Response
{
"data": {
"removeCompanyRelationshipPartner": {
"discarded": RelationshipPartner,
"failReasons": ["abc123"]
}
}
}
removeContactList
Description
Remove list
Response
Returns a RemoveListMutationPayload
Arguments
| Name | Description |
|---|---|
uid - ID!
|
Example
Query
mutation RemoveContactList($uid: ID!) {
removeContactList(uid: $uid) {
failReasons
}
}
Variables
{"uid": 4}
Response
{
"data": {
"removeContactList": {
"failReasons": ["xyz789"]
}
}
}
removeGenericListItems
Response
Returns a RemoveGenericListItemsMutationPayload
Arguments
| Name | Description |
|---|---|
uids - [ID!]!
|
Example
Query
mutation RemoveGenericListItems($uids: [ID!]!) {
removeGenericListItems(uids: $uids) {
failReasons
}
}
Variables
{"uids": [4]}
Response
{
"data": {
"removeGenericListItems": {
"failReasons": ["xyz789"]
}
}
}
removeKeyActivity
Description
Remove key activity for a interaction and optionally from a list.
Response
Returns a RemoveKeyActivityMutationPayload
Example
Query
mutation RemoveKeyActivity(
$keyActivityListUid: ID,
$keyActivityUid: ID!,
$removeFromEntities: Boolean
) {
removeKeyActivity(
keyActivityListUid: $keyActivityListUid,
keyActivityUid: $keyActivityUid,
removeFromEntities: $removeFromEntities
) {
failReasons
}
}
Variables
{
"keyActivityListUid": "4",
"keyActivityUid": 4,
"removeFromEntities": true
}
Response
{
"data": {
"removeKeyActivity": {
"failReasons": ["abc123"]
}
}
}
removeMembersFromContactList
Description
Bulk remove contacts from list
Response
Returns a BulkRemoveListMemberMutationPayload
Example
Query
mutation RemoveMembersFromContactList(
$listMemberEmails: [String!],
$listMemberUids: [ID!],
$uid: ID!
) {
removeMembersFromContactList(
listMemberEmails: $listMemberEmails,
listMemberUids: $listMemberUids,
uid: $uid
) {
failReasons
}
}
Variables
{
"listMemberEmails": ["abc123"],
"listMemberUids": [4],
"uid": "4"
}
Response
{
"data": {
"removeMembersFromContactList": {
"failReasons": ["xyz789"]
}
}
}
reopenMyTask
Description
Reopen my task
Response
Returns a ReopenMyTaskMutationPayload
Arguments
| Name | Description |
|---|---|
taskUid - ID!
|
Example
Query
mutation ReopenMyTask($taskUid: ID!) {
reopenMyTask(taskUid: $taskUid) {
failReasons
task {
assignees {
...EmployeeFragment
}
completedAt
createdAt
description {
...RichContentFragment
}
dueOn
id
requestor {
...EmployeeFragment
}
source {
...MyTaskSourceFragment
}
title
updatedAt
}
}
}
Variables
{"taskUid": "4"}
Response
{
"data": {
"reopenMyTask": {
"failReasons": ["xyz789"],
"task": MyTask
}
}
}
scheduleEmailMarketingCampaign
Description
Schedules an existing draft email marketing campaign
Response
Returns a ScheduleCampaignMutationPayload
Arguments
| Name | Description |
|---|---|
scheduledAt - ISO8601DateTime!
|
A timestamp not including the timezone |
scheduledAtTimezone - String
|
The timezone to schedule the campaign in. Default = "UTC" |
uid - ID!
|
Example
Query
mutation ScheduleEmailMarketingCampaign(
$scheduledAt: ISO8601DateTime!,
$scheduledAtTimezone: String,
$uid: ID!
) {
scheduleEmailMarketingCampaign(
scheduledAt: $scheduledAt,
scheduledAtTimezone: $scheduledAtTimezone,
uid: $uid
) {
failReasons
scheduledCampaign {
allowContinuousResend
analytics {
...CampaignAnalyticsFragment
}
attachment {
...FileFragment
}
clickTracking
continuous
createdAt
createdBy {
...UserFragment
}
fromEmail
id
openTracking
project {
...ProjectFragment
}
projectUrl
recipientList {
...ListFragment
}
recipientListFilter {
...CampaignRecipientListFilterFragment
}
scheduledAt
sender {
...SenderFragment
}
sentAt
status
subject
templateHtml
templateJson
title
updatedAt
usageMode
}
}
}
Variables
{
"scheduledAt": ISO8601DateTime,
"scheduledAtTimezone": "UTC",
"uid": "4"
}
Response
{
"data": {
"scheduleEmailMarketingCampaign": {
"failReasons": ["xyz789"],
"scheduledCampaign": Campaign
}
}
}
setUserRole
Use
update_user_role instead Description
Sets User Role. If User does not exist it will create it
Response
Returns a SetUserRoleMutationPayload
Example
Query
mutation SetUserRole(
$email: String!,
$role: RoleCode
) {
setUserRole(
email: $email,
role: $role
) {
failReasons
user {
accessRole {
...AccessRoleFragment
}
archivedAt
canArchiveContactsAndCompanies
canUpdateCompanyName
canViewActivityViewDetail
canViewEmbeddedReport
delegateAccess
email
employee {
...EmployeeFragment
}
firstName
id
isActive
isSuperAdmin
lastLoginAt
lastName
profileImageUrl
profileName
role
userId
}
}
}
Variables
{"email": "xyz789", "role": "ADMIN"}
Response
{
"data": {
"setUserRole": {
"failReasons": ["xyz789"],
"user": User
}
}
}
showEmployee
Description
Show Employee in drop down selections and optional restore the contact as well
Response
Returns a ShowEmployeeMutationPayload
Example
Query
mutation ShowEmployee(
$andActivateContact: Boolean,
$uid: String!
) {
showEmployee(
andActivateContact: $andActivateContact,
uid: $uid
) {
failReasons
}
}
Variables
{
"andActivateContact": true,
"uid": "xyz789"
}
Response
{
"data": {
"showEmployee": {
"failReasons": ["xyz789"]
}
}
}
syncOutlookContactForUser
Description
Sync contact from Nexl to Outlook Personal Contact for a user
Response
Returns a SyncOutlookContactForUserMutationPayload
Example
Query
mutation SyncOutlookContactForUser(
$contactUid: ID!,
$userEmail: String!
) {
syncOutlookContactForUser(
contactUid: $contactUid,
userEmail: $userEmail
) {
failReasons
}
}
Variables
{"contactUid": 4, "userEmail": "xyz789"}
Response
{
"data": {
"syncOutlookContactForUser": {
"failReasons": ["xyz789"]
}
}
}
trackBouncedEmail
Description
Create a interaction
Response
Returns a TrackBouncedEmailMutationPayload
Arguments
| Name | Description |
|---|---|
bouncedAt - ISO8601DateTime
|
|
comment - String
|
|
email - String!
|
|
sentByEmail - String
|
Example
Query
mutation TrackBouncedEmail(
$bouncedAt: ISO8601DateTime,
$comment: String,
$email: String!,
$sentByEmail: String
) {
trackBouncedEmail(
bouncedAt: $bouncedAt,
comment: $comment,
email: $email,
sentByEmail: $sentByEmail
) {
failReasons
}
}
Variables
{
"bouncedAt": ISO8601DateTime,
"comment": "abc123",
"email": "xyz789",
"sentByEmail": "xyz789"
}
Response
{
"data": {
"trackBouncedEmail": {
"failReasons": ["abc123"]
}
}
}
unblockDomain
Description
Unblock domain and subdomains to start recording interactions again
Response
Returns an UnblockDomainMutationPayload
Arguments
| Name | Description |
|---|---|
value - String!
|
Example
Query
mutation UnblockDomain($value: String!) {
unblockDomain(value: $value) {
failReasons
}
}
Variables
{"value": "xyz789"}
Response
{
"data": {
"unblockDomain": {
"failReasons": ["abc123"]
}
}
}
unblockEmail
Description
Unblocks email to start recording interactions again
Response
Returns an UnblockEmailMutationPayload
Arguments
| Name | Description |
|---|---|
value - String!
|
Example
Query
mutation UnblockEmail($value: String!) {
unblockEmail(value: $value) {
failReasons
}
}
Variables
{"value": "xyz789"}
Response
{
"data": {
"unblockEmail": {
"failReasons": ["xyz789"]
}
}
}
updateCompany
Description
Update a company
Response
Returns an UpdateCompanyMutationPayload
Arguments
| Name | Description |
|---|---|
attributes - CompanyAttributes
|
|
companyTypeUid - ID
|
company type id or company type name |
companyTypesUids - [ID!]
|
secondary company type id or name |
externalIdentifier - ExternalIdentifierInput
|
|
secondaryCompanyTypeUids - [ID!]
|
secondary company type id or name |
uid - ID!
|
Example
Query
mutation UpdateCompany(
$attributes: CompanyAttributes,
$companyTypeUid: ID,
$companyTypesUids: [ID!],
$externalIdentifier: ExternalIdentifierInput,
$secondaryCompanyTypeUids: [ID!],
$uid: ID!
) {
updateCompany(
attributes: $attributes,
companyTypeUid: $companyTypeUid,
companyTypesUids: $companyTypesUids,
externalIdentifier: $externalIdentifier,
secondaryCompanyTypeUids: $secondaryCompanyTypeUids,
uid: $uid
) {
failReasons
record {
archivedAt
companyHierarchy {
...CompanyHierarchyFragment
}
companyType {
...CompanyCustomTypeFragment
}
companyTypes {
...CompanyCustomTypeFragment
}
contacts
createdAt
domain
domains
externalIdentifier {
...ExternalIdentifierFragment
}
hasCustomLogo
id
info {
...CompanyInfoFragment
}
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isBlocked
isInternal
isSubDomainCompany
logoUrl
openOpportunityCount
pendingTaskCount
secondaryTypes {
...CompanyCustomTypeFragment
}
upcomingMeetingCount
updatedAt
}
}
}
Variables
{
"attributes": CompanyAttributes,
"companyTypeUid": 4,
"companyTypesUids": ["4"],
"externalIdentifier": ExternalIdentifierInput,
"secondaryCompanyTypeUids": [4],
"uid": "4"
}
Response
{
"data": {
"updateCompany": {
"failReasons": ["abc123"],
"record": Company
}
}
}
updateCompanyNote
Description
Update a company note
Response
Returns an UpdateCompanyNoteMutationPayload
Arguments
| Name | Description |
|---|---|
access - CompanyNoteAccess
|
|
content - String!
|
|
uid - ID!
|
Example
Query
mutation UpdateCompanyNote(
$access: CompanyNoteAccess,
$content: String!,
$uid: ID!
) {
updateCompanyNote(
access: $access,
content: $content,
uid: $uid
) {
failReasons
record {
access
company {
...CompanyFragment
}
contact {
...ContactFragment
}
content {
...RichContentFragment
}
createdAt
creator {
...UserFragment
}
creatorName
id
updatedAt
updater {
...UserFragment
}
}
}
}
Variables
{
"access": "CUSTOM",
"content": "abc123",
"uid": "4"
}
Response
{
"data": {
"updateCompanyNote": {
"failReasons": ["abc123"],
"record": CompanyNote
}
}
}
updateCompanyOfficeLocation
Description
Update company office location
Response
Returns an UpdateOfficeLocationMutationPayload
Arguments
| Name | Description |
|---|---|
companyOfficeLocationId - ID!
|
|
headquarterLocation - Boolean
|
|
labels - [String!]
|
|
locationAttributes - LocationAttributes
|
|
primaryLocation - Boolean
|
Example
Query
mutation UpdateCompanyOfficeLocation(
$companyOfficeLocationId: ID!,
$headquarterLocation: Boolean,
$labels: [String!],
$locationAttributes: LocationAttributes,
$primaryLocation: Boolean
) {
updateCompanyOfficeLocation(
companyOfficeLocationId: $companyOfficeLocationId,
headquarterLocation: $headquarterLocation,
labels: $labels,
locationAttributes: $locationAttributes,
primaryLocation: $primaryLocation
) {
failReasons
record {
companyOfficeLocationId
headquarter
id
labels
location {
...LocationFragment
}
primary
}
}
}
Variables
{
"companyOfficeLocationId": "4",
"headquarterLocation": false,
"labels": ["abc123"],
"locationAttributes": LocationAttributes,
"primaryLocation": true
}
Response
{
"data": {
"updateCompanyOfficeLocation": {
"failReasons": ["xyz789"],
"record": CompanyOfficeLocation
}
}
}
updateConnectedList
Description
Update a list of third party ems details
Response
Returns an UpdateConnectedListMutationPayload
Example
Query
mutation UpdateConnectedList(
$externalUrl: String,
$lastSyncAt: String,
$listUid: String!,
$nameOnEms: String
) {
updateConnectedList(
externalUrl: $externalUrl,
lastSyncAt: $lastSyncAt,
listUid: $listUid,
nameOnEms: $nameOnEms
) {
failReasons
}
}
Variables
{
"externalUrl": "abc123",
"lastSyncAt": "xyz789",
"listUid": "xyz789",
"nameOnEms": "xyz789"
}
Response
{
"data": {
"updateConnectedList": {
"failReasons": ["xyz789"]
}
}
}
updateContact
Description
Update a contact
Response
Returns an UpdateContactMutationPayload
Arguments
| Name | Description |
|---|---|
attributes - ContactAttributes!
|
|
companyName - String
|
|
emailAddress - String
|
|
emailAddresses - [EmailEntryInput!]
|
|
officeLocationId - ID
|
|
uid - ID!
|
Example
Query
mutation UpdateContact(
$attributes: ContactAttributes!,
$companyName: String,
$emailAddress: String,
$emailAddresses: [EmailEntryInput!],
$officeLocationId: ID,
$uid: ID!
) {
updateContact(
attributes: $attributes,
companyName: $companyName,
emailAddress: $emailAddress,
emailAddresses: $emailAddresses,
officeLocationId: $officeLocationId,
uid: $uid
) {
failReasons
record {
archivedAt
changedJob
company {
...CompanyFragment
}
contactCompanySwitch {
...ContactCompanySwitchFragment
}
createdAt
emailAddresses
id
inMyContacts
info {
...ContactInfoFragment
}
interactionsIsEngaged
interactionsLast {
...LastAtsFragment
}
interactionsTotal {
...TotalsFragment
}
isActive
isArchived
isEmployee
isKeyContact
isPersonal
marketingListConsent {
...ContactConsentFragment
}
officeLocation {
...CompanyOfficeLocationFragment
}
primaryEmail
unarchiveOnNextInteraction
updatedAt
}
}
}
Variables
{
"attributes": ContactAttributes,
"companyName": "xyz789",
"emailAddress": "abc123",
"emailAddresses": [EmailEntryInput],
"officeLocationId": 4,
"uid": 4
}
Response
{
"data": {
"updateContact": {
"failReasons": ["abc123"],
"record": Contact
}
}
}
updateContactConsent
Description
Update or set a contact consent
Response
Returns an UpdateContactConsentMutationPayload
Arguments
| Name | Description |
|---|---|
attributes - ContactConsentAttribute!
|
|
contactUid - ID!
|
Example
Query
mutation UpdateContactConsent(
$attributes: ContactConsentAttribute!,
$contactUid: ID!
) {
updateContactConsent(
attributes: $attributes,
contactUid: $contactUid
) {
failReasons
record {
autoChangedReason
howWasConsentGiven
id
status
whenWasConsentGiven
}
}
}
Variables
{
"attributes": ContactConsentAttribute,
"contactUid": "4"
}
Response
{
"data": {
"updateContactConsent": {
"failReasons": ["abc123"],
"record": ContactConsent
}
}
}
updateContactCustomField
Description
Update a contact custom field using a string value
Response
Returns an UpdateContactCustomFieldMutationPayload
Example
Query
mutation UpdateContactCustomField(
$contactUid: ID!,
$schemaUid: ID!,
$stringValue: String
) {
updateContactCustomField(
contactUid: $contactUid,
schemaUid: $schemaUid,
stringValue: $stringValue
) {
failReasons
}
}
Variables
{
"contactUid": 4,
"schemaUid": "4",
"stringValue": "xyz789"
}
Response
{
"data": {
"updateContactCustomField": {
"failReasons": ["abc123"]
}
}
}
updateContactList
Description
Update a list
Response
Returns an UpdateListMutationPayload
Arguments
| Name | Description |
|---|---|
category - ListCategory
|
|
name - String
|
|
uid - ID!
|
Example
Query
mutation UpdateContactList(
$category: ListCategory,
$name: String,
$uid: ID!
) {
updateContactList(
category: $category,
name: $name,
uid: $uid
) {
failReasons
list {
allowDuplicates
category
clean {
...CleanFragment
}
contactsCount
createdAt
creator {
...UserFragment
}
discardedAt
filterCriteria
id
listType
memberCustomFields {
...CustomFieldSchemaFragment
}
name
reminderSettings {
...ReminderSettingFragment
}
renderMode
searchTerm
tabUid
updatedAt
}
}
}
Variables
{
"category": "CLIENT_ALERT",
"name": "xyz789",
"uid": "4"
}
Response
{
"data": {
"updateContactList": {
"failReasons": ["xyz789"],
"list": List
}
}
}
updateEmailMarketingCampaign
Description
Updates an existing email marketing campaign
Response
Returns an UpdateCampaignMutationPayload
Example
Query
mutation UpdateEmailMarketingCampaign(
$allowContinuousResend: Boolean,
$clickTracking: Boolean,
$continuous: Boolean,
$openTracking: Boolean,
$recipientListId: ID,
$senderId: ID,
$subject: String,
$templateJson: String,
$title: String,
$uid: ID!
) {
updateEmailMarketingCampaign(
allowContinuousResend: $allowContinuousResend,
clickTracking: $clickTracking,
continuous: $continuous,
openTracking: $openTracking,
recipientListId: $recipientListId,
senderId: $senderId,
subject: $subject,
templateJson: $templateJson,
title: $title,
uid: $uid
) {
failReasons
updatedCampaign {
allowContinuousResend
analytics {
...CampaignAnalyticsFragment
}
attachment {
...FileFragment
}
clickTracking
continuous
createdAt
createdBy {
...UserFragment
}
fromEmail
id
openTracking
project {
...ProjectFragment
}
projectUrl
recipientList {
...ListFragment
}
recipientListFilter {
...CampaignRecipientListFilterFragment
}
scheduledAt
sender {
...SenderFragment
}
sentAt
status
subject
templateHtml
templateJson
title
updatedAt
usageMode
}
}
}
Variables
{
"allowContinuousResend": false,
"clickTracking": false,
"continuous": true,
"openTracking": true,
"recipientListId": 4,
"senderId": 4,
"subject": "xyz789",
"templateJson": "abc123",
"title": "xyz789",
"uid": "4"
}
Response
{
"data": {
"updateEmailMarketingCampaign": {
"failReasons": ["xyz789"],
"updatedCampaign": Campaign
}
}
}
updateGenericListItems
Response
Returns an UpdateGenericListItemsMutationPayload
Arguments
| Name | Description |
|---|---|
customFieldAttributes - [CustomFieldAttribute!]
|
|
uids - [ID!]!
|
Example
Query
mutation UpdateGenericListItems(
$customFieldAttributes: [CustomFieldAttribute!],
$uids: [ID!]!
) {
updateGenericListItems(
customFieldAttributes: $customFieldAttributes,
uids: $uids
) {
failReasons
records {
completedTasksCount
createdAt
customFields {
...CustomFieldFragment
}
genericList {
...GenericListFragment
}
gridCustomFields {
...CustomFieldGridFragment
}
id
listReminders {
...ReminderFragment
}
tasksCount
updatedAt
}
}
}
Variables
{
"customFieldAttributes": [CustomFieldAttribute],
"uids": [4]
}
Response
{
"data": {
"updateGenericListItems": {
"failReasons": ["abc123"],
"records": [GenericListItem]
}
}
}
updateMyTask
Description
update my task
Response
Returns an UpdateMyTaskMutationPayload
Example
Query
mutation UpdateMyTask(
$assigneeUid: ID,
$description: String,
$dueOn: String,
$taskUid: ID!,
$title: String
) {
updateMyTask(
assigneeUid: $assigneeUid,
description: $description,
dueOn: $dueOn,
taskUid: $taskUid,
title: $title
) {
failReasons
task {
assignees {
...EmployeeFragment
}
completedAt
createdAt
description {
...RichContentFragment
}
dueOn
id
requestor {
...EmployeeFragment
}
source {
...MyTaskSourceFragment
}
title
updatedAt
}
}
}
Variables
{
"assigneeUid": 4,
"description": "abc123",
"dueOn": "abc123",
"taskUid": 4,
"title": "xyz789"
}
Response
{
"data": {
"updateMyTask": {
"failReasons": ["xyz789"],
"task": MyTask
}
}
}
updateOpportunity
Description
Update company opportunity
Response
Returns an OpportunityTrackingUpdateOpportunityMutationPayload
Arguments
| Name | Description |
|---|---|
attributes - CompanyGoalAttributes
|
|
customStatusUid - ID
|
Status Name or Status id |
uuid - ID!
|
Opportunity id or tracking number |
Example
Query
mutation UpdateOpportunity(
$attributes: CompanyGoalAttributes,
$customStatusUid: ID,
$uuid: ID!
) {
updateOpportunity(
attributes: $attributes,
customStatusUid: $customStatusUid,
uuid: $uuid
) {
failReasons
gridRecord {
assignedTo {
...EmployeeGridFragment
}
commsLast {
...LastAtsFragment
}
company {
...CompanyGridFragment
}
createdAt
createdBy {
...UserGridFragment
}
customFields {
...CustomFieldGridFragment
}
customStatus {
...OpportunityTrackingCustomStatusFragment
}
date
id
keyContacts {
...ContactGridFragment
}
othersIncluded {
...EmployeeGridFragment
}
proposedFeeAmount {
...MoneyFragment
}
referralSource {
...ContactGridFragment
}
tags
title
trackingNumber
updatedAt
}
record {
archived
assignedTo {
...EmployeeFragment
}
company {
...CompanyFragment
}
contactLast {
...LastAtsFragment
}
createdAt
createdBy {
...UserFragment
}
customFields {
...CustomFieldFragment
}
customStatus {
...OpportunityTrackingCustomStatusFragment
}
date
description {
...RichContentFragment
}
documents {
... on DocumentFile {
...DocumentFileFragment
}
... on DocumentUrl {
...DocumentUrlFragment
}
}
emailBody {
...RichContentFragment
}
id
includedLawyers {
...EmployeeFragment
}
keyContacts {
...ContactFragment
}
outcome
project {
...ProjectFragment
}
proposedFee
proposedFeeAmount {
...MoneyFragment
}
receivedReferral
referralSource {
...ContactFragment
}
tags
title
trackingNumber
updatedAt
}
}
}
Variables
{
"attributes": CompanyGoalAttributes,
"customStatusUid": 4,
"uuid": 4
}
Response
{
"data": {
"updateOpportunity": {
"failReasons": ["abc123"],
"gridRecord": OpportunityGrid,
"record": CompanyGoal
}
}
}
updateProject
Response
Returns an UpdateProjectMutationPayload
Arguments
| Name | Description |
|---|---|
attributes - ProjectAttribute!
|
|
uuid - ID!
|
Example
Query
mutation UpdateProject(
$attributes: ProjectAttribute!,
$uuid: ID!
) {
updateProject(
attributes: $attributes,
uuid: $uuid
) {
failReasons
}
}
Variables
{
"attributes": ProjectAttribute,
"uuid": "4"
}
Response
{
"data": {
"updateProject": {
"failReasons": ["abc123"]
}
}
}
updateSentReferral
Response
Returns an UpdateSentReferralMutationPayload
Arguments
| Name | Description |
|---|---|
clientContactUid - ID
|
|
customFieldAttributes - [CustomFieldAttribute!]
|
|
referredByEmployeeUid - ID
|
|
resultStatus - SentReferralResultStatus
|
|
sentAt - ISO8601DateTime
|
|
sentReferralUid - ID!
|
|
typeOfLegalMatter - String
|
Example
Query
mutation UpdateSentReferral(
$clientContactUid: ID,
$customFieldAttributes: [CustomFieldAttribute!],
$referredByEmployeeUid: ID,
$resultStatus: SentReferralResultStatus,
$sentAt: ISO8601DateTime,
$sentReferralUid: ID!,
$typeOfLegalMatter: String
) {
updateSentReferral(
clientContactUid: $clientContactUid,
customFieldAttributes: $customFieldAttributes,
referredByEmployeeUid: $referredByEmployeeUid,
resultStatus: $resultStatus,
sentAt: $sentAt,
sentReferralUid: $sentReferralUid,
typeOfLegalMatter: $typeOfLegalMatter
) {
failReasons
record {
clientCompany {
...CompanyFragment
}
clientContact {
...ContactFragment
}
createdAt
customFields {
...CustomFieldFragment
}
discardedAt
externalIdentifier
id
referredByEmployee {
...EmployeeFragment
}
resultStatus
sentAt
sentToContact {
...ContactFragment
}
typeOfLegalMatter
updatedAt
}
}
}
Variables
{
"clientContactUid": 4,
"customFieldAttributes": [CustomFieldAttribute],
"referredByEmployeeUid": "4",
"resultStatus": "SENT",
"sentAt": ISO8601DateTime,
"sentReferralUid": 4,
"typeOfLegalMatter": "xyz789"
}
Response
{
"data": {
"updateSentReferral": {
"failReasons": ["abc123"],
"record": SentReferral
}
}
}
updateSyncListRequest
Description
Update a list of third party ems sync request details
Response
Returns an UpdateSyncListRequestMutationPayload
Example
Query
mutation UpdateSyncListRequest(
$completedAt: String,
$error: String,
$uid: String!
) {
updateSyncListRequest(
completedAt: $completedAt,
error: $error,
uid: $uid
) {
failReasons
}
}
Variables
{
"completedAt": "xyz789",
"error": "xyz789",
"uid": "abc123"
}
Response
{
"data": {
"updateSyncListRequest": {
"failReasons": ["xyz789"]
}
}
}
updateTagsOnCompanies
Description
Add, remove or replace tags on companies
Response
Returns an UpdateTagsOnCompaniesMutationPayload
Arguments
| Name | Description |
|---|---|
add - String
|
Newline separated list of tags that needs to be added |
companyUid - ID!
|
Newline separated list of company ids or company domains |
remove - String
|
Newline separated list of tags that needs to be removed |
replace - String
|
Newline separated list of tags to set, replacing any existing tags |
Example
Query
mutation UpdateTagsOnCompanies(
$add: String,
$companyUid: ID!,
$remove: String,
$replace: String
) {
updateTagsOnCompanies(
add: $add,
companyUid: $companyUid,
remove: $remove,
replace: $replace
) {
failReasons
infos {
correspondenceEmails
correspondenceNumbers
description
headquarterLocation {
...CompanyOfficeLocationFragment
}
id
industryNames
internalIndustries {
...InternalIndustryFragment
}
internalIndustryNames
linkedinUrl
locations {
...LocationFragment
}
name
numberOfEmployees
primaryLocation {
...CompanyOfficeLocationFragment
}
tags
twitterUrl
website
}
}
}
Variables
{
"add": "abc123",
"companyUid": 4,
"remove": "abc123",
"replace": "xyz789"
}
Response
{
"data": {
"updateTagsOnCompanies": {
"failReasons": ["xyz789"],
"infos": [CompanyInfo]
}
}
}
updateTagsOnContacts
Description
Add, remove or replace tags on contacts
Response
Returns an UpdateTagsOnContactsMutationPayload
Arguments
| Name | Description |
|---|---|
add - String
|
Newline separated list of tags that needs to be added |
contactUid - ID!
|
Newline separated list of contact ids or contact email |
remove - String
|
Newline separated list of tags that needs to be removed |
replace - String
|
Newline separated list of tags to set, replacing any existing tags |
Example
Query
mutation UpdateTagsOnContacts(
$add: String,
$contactUid: ID!,
$remove: String,
$replace: String
) {
updateTagsOnContacts(
add: $add,
contactUid: $contactUid,
remove: $remove,
replace: $replace
) {
failReasons
infos {
customFields {
...CustomFieldFragment
}
department
displayName
educations
firstName
gender
id
imageUrl
jobTitle
lastName
linkedinUrl
location {
...LocationFragment
}
office
phoneNumbers
phoneNumbersWithType {
...PhoneNumberFragment
}
tags
twitterUrl
}
}
}
Variables
{
"add": "xyz789",
"contactUid": "4",
"remove": "abc123",
"replace": "xyz789"
}
Response
{
"data": {
"updateTagsOnContacts": {
"failReasons": ["abc123"],
"infos": [ContactInfo]
}
}
}
updateUserRole
Description
Updates a role for a user
Response
Returns an UpdateUserMutationPayload
Example
Query
mutation UpdateUserRole(
$roleUid: ID!,
$userUid: ID!
) {
updateUserRole(
roleUid: $roleUid,
userUid: $userUid
) {
failReasons
user {
accessRole {
...AccessRoleFragment
}
archivedAt
canArchiveContactsAndCompanies
canUpdateCompanyName
canViewActivityViewDetail
canViewEmbeddedReport
delegateAccess
email
employee {
...EmployeeFragment
}
firstName
id
isActive
isSuperAdmin
lastLoginAt
lastName
profileImageUrl
profileName
role
userId
}
}
}
Variables
{
"roleUid": "4",
"userUid": "4"
}
Response
{
"data": {
"updateUserRole": {
"failReasons": ["xyz789"],
"user": User
}
}
}
Types
AccessRole
Fields
| Field Name | Description |
|---|---|
description - String
|
|
id - ID!
|
|
isPersisted - Boolean!
|
|
name - String!
|
|
updatedAt - ISO8601DateTime
|
Example
{
"description": "abc123",
"id": 4,
"isPersisted": false,
"name": "xyz789",
"updatedAt": ISO8601DateTime
}
AccessRoleEntries
Fields
| Field Name | Description |
|---|---|
entries - [AccessRole!]!
|
Example
{"entries": [AccessRole]}
AccountColour
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COL1"
AddClientCompanyForSyncMutationPayload
Description
Autogenerated return type of AddClientCompanyForSyncMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
AddCompanyListMemberMutationPayload
Description
Autogenerated return type of AddCompanyListMemberMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - CompanyListMember
|
Example
{
"failReasons": ["abc123"],
"record": CompanyListMember
}
AddCompanyTagsMutationPayload
Description
Autogenerated return type of AddCompanyTagsMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
AddCompanyToHierarchyMutationPayload
Description
Autogenerated return type of AddCompanyToHierarchyMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
AddContactToListMutationPayload
Description
Autogenerated return type of AddContactToListMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
gridMemberRecord - ContactListGridMember
|
|
record - ListMember
|
Example
{
"failReasons": ["xyz789"],
"gridMemberRecord": ContactListGridMember,
"record": ListMember
}
AddOptionMutationPayload
Description
Autogenerated return type of AddOptionMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
AddProjectMembersMutationPayload
Description
Autogenerated return type of AddProjectMembersMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
AddRecipientMutationPayload
Description
Autogenerated return type of AddRecipientMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
AddTagsToContactsMutationPayload
Description
Autogenerated return type of AddTagsToContactsMutation.
Fields
| Field Name | Description |
|---|---|
contactCards - [ContactCard!]
|
|
failReasons - [String!]!
|
Example
{
"contactCards": [ContactCard],
"failReasons": ["abc123"]
}
ArchiveContactMutationPayload
Description
Autogenerated return type of ArchiveContactMutation.
Fields
| Field Name | Description |
|---|---|
contact - Contact
|
|
failReasons - [String!]!
|
Example
{
"contact": Contact,
"failReasons": ["abc123"]
}
ArchiveUserMutationPayload
Description
Autogenerated return type of ArchiveUserMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
user - User
|
Example
{
"failReasons": ["xyz789"],
"user": User
}
BigInt
Description
Represents non-fractional signed whole numeric values. Since the value may exceed the size of a 32-bit integer, it's encoded as a string.
Example
{}
BlockDomainMutationPayload
Description
Autogenerated return type of BlockDomainMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
BlockPage
Fields
| Field Name | Description |
|---|---|
content - String
|
No longer used |
contentInBinary - String
|
|
createdAt - ISO8601DateTime!
|
|
discardedAt - ISO8601DateTime
|
|
iconCode - String
|
|
id - ID!
|
|
name - String
|
|
position - Int
|
Example
{
"content": "xyz789",
"contentInBinary": "abc123",
"createdAt": ISO8601DateTime,
"discardedAt": ISO8601DateTime,
"iconCode": "abc123",
"id": "4",
"name": "xyz789",
"position": 123
}
BlockPageList
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
pages - [BlockPage!]!
|
Example
{
"id": 4,
"name": "xyz789",
"pages": [BlockPage]
}
BlockedDomainEntries
Fields
| Field Name | Description |
|---|---|
entries - [BlockedValue!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [BlockedValue],
"pageInfo": PagingInfo
}
BlockedEmailEntries
Fields
| Field Name | Description |
|---|---|
entries - [BlockedValue!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [BlockedValue],
"pageInfo": PagingInfo
}
BlockedValue
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
value - String!
|
Example
{
"createdAt": ISO8601DateTime,
"value": "xyz789"
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
BooleanContactSearchFilter
Fields
| Input Field | Description |
|---|---|
operator - BooleanSearchOperator!
|
|
property - BooleanContactSearchableProperty!
|
|
values - [String!]
|
Example
{
"operator": "NO",
"property": "KEY_CONTACT",
"values": ["abc123"]
}
BooleanContactSearchableProperty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"KEY_CONTACT"
BooleanSearchOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NO"
BulkRemoveListMemberMutationPayload
Description
Autogenerated return type of BulkRemoveListMemberMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
BulkUpdateListMemberMutationPayload
Description
Autogenerated return type of BulkUpdateListMemberMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
gridMemberRecords - [ContactListGridMember!]!
|
|
records - [ListMember!]!
|
Example
{
"failReasons": ["xyz789"],
"gridMemberRecords": [ContactListGridMember],
"records": [ListMember]
}
Campaign
Fields
| Field Name | Description |
|---|---|
allowContinuousResend - Boolean!
|
|
analytics - CampaignAnalytics
|
|
attachment - File
|
|
clickTracking - Boolean!
|
|
continuous - Boolean!
|
|
createdAt - ISO8601DateTime!
|
|
createdBy - User!
|
|
fromEmail - String
|
Use sender { email } instead |
id - ID!
|
|
openTracking - Boolean!
|
|
project - Project
|
|
projectUrl - String!
|
|
recipientList - List
|
|
recipientListFilter - CampaignRecipientListFilter
|
|
scheduledAt - ISO8601DateTime
|
|
sender - Sender
|
|
sentAt - ISO8601DateTime
|
|
status - CampaignStatus!
|
|
subject - String
|
|
templateHtml - String
|
|
templateJson - String
|
|
title - String!
|
|
updatedAt - ISO8601DateTime!
|
|
usageMode - CampaignUsage
|
Example
{
"allowContinuousResend": true,
"analytics": CampaignAnalytics,
"attachment": File,
"clickTracking": true,
"continuous": false,
"createdAt": ISO8601DateTime,
"createdBy": User,
"fromEmail": "abc123",
"id": 4,
"openTracking": false,
"project": Project,
"projectUrl": "xyz789",
"recipientList": List,
"recipientListFilter": CampaignRecipientListFilter,
"scheduledAt": ISO8601DateTime,
"sender": Sender,
"sentAt": ISO8601DateTime,
"status": "ACTIVE",
"subject": "abc123",
"templateHtml": "xyz789",
"templateJson": "xyz789",
"title": "abc123",
"updatedAt": ISO8601DateTime,
"usageMode": "NONE"
}
CampaignAnalytics
Fields
| Field Name | Description |
|---|---|
clickThroughRate - Int!
|
|
percentBounced - Int!
|
Use percent_failed instead |
percentClicked - Int!
|
|
percentComplained - Int!
|
|
percentDelivered - Int!
|
|
percentFailed - Int!
|
|
percentOpened - Int!
|
|
percentSkipped - Int!
|
|
percentUnsubscribed - Int!
|
|
totalAccepted - Int!
|
|
totalBounced - Int!
|
Use total_failed instead |
totalClicked - Int!
|
|
totalComplained - Int!
|
|
totalDelivered - Int!
|
|
totalFailed - Int!
|
|
totalOpened - Int!
|
|
totalRecipients - Int!
|
|
totalSkipped - Int!
|
|
totalUnsubscribed - Int!
|
Example
{
"clickThroughRate": 987,
"percentBounced": 123,
"percentClicked": 987,
"percentComplained": 987,
"percentDelivered": 987,
"percentFailed": 987,
"percentOpened": 123,
"percentSkipped": 987,
"percentUnsubscribed": 123,
"totalAccepted": 987,
"totalBounced": 987,
"totalClicked": 123,
"totalComplained": 123,
"totalDelivered": 987,
"totalFailed": 123,
"totalOpened": 123,
"totalRecipients": 987,
"totalSkipped": 123,
"totalUnsubscribed": 123
}
CampaignManager
Fields
| Field Name | Description |
|---|---|
apiType - String!
|
|
connectionDirections - [ConnectionDirection!]!
|
|
connectorType - ConnectorType
|
|
id - ID!
|
|
mappingEnabled - Boolean!
|
Whether the connector has field to field mapping |
name - String!
|
Example
{
"apiType": "xyz789",
"connectionDirections": ["PULL"],
"connectorType": "BREVO",
"id": 4,
"mappingEnabled": true,
"name": "abc123"
}
CampaignRecipientListFilter
Fields
| Field Name | Description |
|---|---|
campaign - Campaign!
|
|
conditions - JSON!
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
recipientList - List!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"campaign": Campaign,
"conditions": {},
"createdAt": ISO8601DateTime,
"id": 4,
"recipientList": List,
"updatedAt": ISO8601DateTime
}
CampaignStatus
Values
| Enum Value | Description |
|---|---|
|
|
All active campaigns |
|
|
Campaign has been archived |
|
|
Campaign is in draft mode |
|
|
Campaign has been schedule to be sent |
|
|
Campaign is currently sending |
|
|
Campaign has been sent |
Example
"ACTIVE"
CampaignUsage
Values
| Enum Value | Description |
|---|---|
|
|
Campaign is not in use anywhere |
|
|
Campaign belongs to a project |
Example
"NONE"
Campaigns
Fields
| Field Name | Description |
|---|---|
entries - [Campaign!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [Campaign],
"pageInfo": PagingInfo
}
CampaignsFilterInput
Fields
| Input Field | Description |
|---|---|
createdAt - DateRangeInput
|
|
createdBy - ID
|
|
scheduledAt - DateRangeInput
|
|
sentAt - DateRangeInput
|
|
status - CampaignStatus
|
|
term - String
|
|
workspaces - [ID!]
|
Example
{
"createdAt": DateRangeInput,
"createdBy": 4,
"scheduledAt": DateRangeInput,
"sentAt": DateRangeInput,
"status": "ACTIVE",
"term": "xyz789",
"workspaces": [4]
}
CareerCompany
Fields
| Field Name | Description |
|---|---|
company - Company
|
|
companyDisplayName - String!
|
|
companyId - ID
|
|
companyLinkedinUrl - Url
|
|
companyName - String
|
|
currentStartDate - ISO8601Date
|
|
id - ID!
|
|
jobTitle - String
|
|
jobTitles - [ContactJobTitle!]!
|
Example
{
"company": Company,
"companyDisplayName": "abc123",
"companyId": 4,
"companyLinkedinUrl": Url,
"companyName": "abc123",
"currentStartDate": ISO8601Date,
"id": 4,
"jobTitle": "xyz789",
"jobTitles": [ContactJobTitle]
}
ClassifyEmailMutationPayload
Description
Autogenerated return type of ClassifyEmailMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
Clean
Fields
| Field Name | Description |
|---|---|
beenCleaned - Boolean!
|
Whether this list has been completely cleaned at some point in the past |
cleanEnd - ISO8601DateTime
|
|
cleanStart - ISO8601DateTime
|
|
id - ID
|
|
listType - ListType!
|
|
percentComplete - Int!
|
|
status - ExecutionStatus
|
Overall status of the cleaning process |
totalBounced - Int!
|
|
totalConsentNotGiven - Int!
|
|
totalHighRisk - Int!
|
|
totalLowRisk - Int!
|
|
totalMediumRisk - Int!
|
|
totalMembers - Int!
|
|
totalUnengaged - Int!
|
|
totalUnsubscribed - Int!
|
Example
{
"beenCleaned": false,
"cleanEnd": ISO8601DateTime,
"cleanStart": ISO8601DateTime,
"id": 4,
"listType": "DYNAMIC",
"percentComplete": 987,
"status": "AWAITING_START",
"totalBounced": 123,
"totalConsentNotGiven": 123,
"totalHighRisk": 123,
"totalLowRisk": 123,
"totalMediumRisk": 123,
"totalMembers": 987,
"totalUnengaged": 123,
"totalUnsubscribed": 123
}
ColumnConditionInput
Fields
| Input Field | Description |
|---|---|
operation - ColumnFilterOperationEnum!
|
|
value - String
|
|
valueTo - String
|
Example
{
"operation": "BLANK",
"value": "xyz789",
"valueTo": "xyz789"
}
ColumnFilterInput
Fields
| Input Field | Description |
|---|---|
columnUid - ID!
|
|
conditions - [ColumnConditionInput!]!
|
|
joinOperator - ColumnJoinOperatorEnum!
|
Example
{
"columnUid": 4,
"conditions": [ColumnConditionInput],
"joinOperator": "AND"
}
ColumnFilterOperationEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BLANK"
ColumnJoinOperatorEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
ColumnsFilteringInput
Fields
| Input Field | Description |
|---|---|
baseFilters - ColumnsFilteringInput
|
|
compositeFilters - [CompositeFilterInput!]
|
|
filters - [ColumnFilterInput!]
|
|
ids - [String!]
|
|
joinOperator - ColumnJoinOperatorEnum!
|
Example
{
"baseFilters": ColumnsFilteringInput,
"compositeFilters": [CompositeFilterInput],
"filters": [ColumnFilterInput],
"ids": ["xyz789"],
"joinOperator": "AND"
}
CompaniesOrderBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANY_NAME_ASC"
Company
Fields
| Field Name | Description |
|---|---|
archivedAt - ISO8601DateTime
|
|
companyHierarchy - CompanyHierarchy!
|
|
companyType - CompanyCustomType!
|
Use company_types |
companyTypes - [CompanyCustomType!]!
|
|
contacts - Int!
|
|
createdAt - ISO8601DateTime!
|
|
domain - String
|
|
domains - [String!]!
|
|
externalIdentifier - ExternalIdentifier
|
|
hasCustomLogo - Boolean!
|
|
id - ID!
|
|
info - CompanyInfo!
|
|
interactionsLast - LastAts!
|
|
interactionsTotal - Totals!
|
|
isBlocked - Boolean!
|
|
isInternal - Boolean!
|
|
isSubDomainCompany - Boolean!
|
|
logoUrl - String
|
|
openOpportunityCount - Int!
|
|
pendingTaskCount - Int!
|
|
secondaryTypes - [CompanyCustomType!]!
|
Use company_types |
upcomingMeetingCount - Int!
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"archivedAt": ISO8601DateTime,
"companyHierarchy": CompanyHierarchy,
"companyType": CompanyCustomType,
"companyTypes": [CompanyCustomType],
"contacts": 987,
"createdAt": ISO8601DateTime,
"domain": "abc123",
"domains": ["xyz789"],
"externalIdentifier": ExternalIdentifier,
"hasCustomLogo": false,
"id": "4",
"info": CompanyInfo,
"interactionsLast": LastAts,
"interactionsTotal": Totals,
"isBlocked": false,
"isInternal": false,
"isSubDomainCompany": true,
"logoUrl": "xyz789",
"openOpportunityCount": 987,
"pendingTaskCount": 987,
"secondaryTypes": [CompanyCustomType],
"upcomingMeetingCount": 123,
"updatedAt": ISO8601DateTime
}
CompanyAttributes
Description
Attributes for company
Fields
| Input Field | Description |
|---|---|
correspondenceEmails - [String!]
|
|
correspondenceNumbers - [String!]
|
|
description - String
|
|
homepage - String
|
|
industryNames - [String!]
|
|
internalIndustryIds - [String!]
|
Internal industry ids or internal industry names |
linkedinUrl - String
|
|
name - String
|
|
numberOfEmployees - Int
|
|
tags - [String!]
|
|
twitterUrl - String
|
|
website - String
|
Example
{
"correspondenceEmails": ["abc123"],
"correspondenceNumbers": ["xyz789"],
"description": "abc123",
"homepage": "xyz789",
"industryNames": ["abc123"],
"internalIndustryIds": ["xyz789"],
"linkedinUrl": "xyz789",
"name": "abc123",
"numberOfEmployees": 987,
"tags": ["abc123"],
"twitterUrl": "xyz789",
"website": "xyz789"
}
CompanyCard
CompanyCustomType
CompanyDetail
Fields
| Field Name | Description |
|---|---|
companyTypes - GridStringArrayScalar
|
|
correspondenceEmails - GridStringArrayScalar
|
|
correspondenceNumbers - GridStringArrayScalar
|
|
description - String
|
|
id - ID!
|
|
industryNames - GridStringArrayScalar
|
|
internalIndustryNames - GridStringArrayScalar
|
|
linkedinUrl - String
|
|
numberOfEmployees - Int
|
|
primaryLocation - CompanyOfficeLocationGrid
|
|
tags - GridStringArrayScalar!
|
|
twitterUrl - String
|
|
website - String
|
Example
{
"companyTypes": GridStringArrayScalar,
"correspondenceEmails": GridStringArrayScalar,
"correspondenceNumbers": GridStringArrayScalar,
"description": "abc123",
"id": 4,
"industryNames": GridStringArrayScalar,
"internalIndustryNames": GridStringArrayScalar,
"linkedinUrl": "xyz789",
"numberOfEmployees": 123,
"primaryLocation": CompanyOfficeLocationGrid,
"tags": GridStringArrayScalar,
"twitterUrl": "xyz789",
"website": "abc123"
}
CompanyEntries
Fields
| Field Name | Description |
|---|---|
entries - [Company!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [Company],
"pageInfo": PagingInfo
}
CompanyFilter
Description
Options for filtering contacts
Fields
| Input Field | Description |
|---|---|
operator - FilterOperator!
|
|
property - CompanyFilterProperty!
|
|
value - String
|
Example
{
"operator": "CONTAINS",
"property": "HEADQUARTER_CITY",
"value": "xyz789"
}
CompanyFilterProperty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HEADQUARTER_CITY"
CompanyFiltering
Description
Filtering Options for companies
Fields
| Input Field | Description |
|---|---|
companyDefaultType - CompanyTypeDefault
|
|
companyTypeUid - ID
|
Filters by company type uid |
companyUids - [ID!]
|
Filters by company uids |
excludeWorkHistoryCompanies - Boolean
|
exclude companies that have been created from work history |
includeArchived - Boolean
|
Include archived companies. Default = false |
includeIndividuals - Boolean
|
|
knowByUid - String
|
Filters by Employee uid or Employee email who knows contacts |
ownerUid - String
|
Filters by owner Employee uid or Employee email |
properties - [CompanyFilter!]
|
|
term - String
|
|
timeFilters - [CompanyTimeFilter!]
|
Example
{
"companyDefaultType": "CLIENT",
"companyTypeUid": 4,
"companyUids": ["4"],
"excludeWorkHistoryCompanies": false,
"includeArchived": true,
"includeIndividuals": false,
"knowByUid": "abc123",
"ownerUid": "abc123",
"properties": [CompanyFilter],
"term": "xyz789",
"timeFilters": [CompanyTimeFilter]
}
CompanyForCustomField
Fields
| Field Name | Description |
|---|---|
domain - String
|
|
id - ID!
|
|
info - CompanyInfoForCustomField!
|
|
logoUrl - String
|
Example
{
"domain": "abc123",
"id": "4",
"info": CompanyInfoForCustomField,
"logoUrl": "xyz789"
}
CompanyGoal
Description
Opportunity information
Fields
| Field Name | Description |
|---|---|
archived - Boolean!
|
|
assignedTo - Employee
|
|
company - Company!
|
|
contactLast - LastAts
|
|
createdAt - ISO8601DateTime!
|
|
createdBy - User
|
|
customFields - [CustomField!]!
|
|
customStatus - OpportunityTrackingCustomStatus
|
|
date - ISO8601Date
|
|
description - RichContent
|
|
documents - [GoalDocument!]!
|
|
emailBody - RichContent
|
|
id - ID!
|
|
includedLawyers - [Employee!]!
|
|
keyContacts - [Contact!]
|
|
outcome - GoalOutcome!
|
|
project - Project
|
|
proposedFee - Float
|
|
proposedFeeAmount - Money
|
|
receivedReferral - Boolean!
|
|
referralSource - Contact
|
|
tags - [String!]!
|
|
title - String
|
|
trackingNumber - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"archived": true,
"assignedTo": Employee,
"company": Company,
"contactLast": LastAts,
"createdAt": ISO8601DateTime,
"createdBy": User,
"customFields": [CustomField],
"customStatus": OpportunityTrackingCustomStatus,
"date": ISO8601Date,
"description": RichContent,
"documents": [DocumentFile],
"emailBody": RichContent,
"id": 4,
"includedLawyers": [Employee],
"keyContacts": [Contact],
"outcome": "LOST",
"project": Project,
"proposedFee": 123.45,
"proposedFeeAmount": Money,
"receivedReferral": true,
"referralSource": Contact,
"tags": ["abc123"],
"title": "abc123",
"trackingNumber": "abc123",
"updatedAt": ISO8601DateTime
}
CompanyGoalAttributes
Description
Attributes for company goal
Fields
| Input Field | Description |
|---|---|
assignedToEmail - String
|
|
assignedToId - ID
|
|
customFieldAttributes - [CustomFieldAttribute!]
|
|
customStatusId - ID
|
|
customStatusUid - ID
|
Status Name or Status id |
date - String
|
|
description - String
|
|
documentUrls - [String!]
|
|
emailBody - String
|
|
internalContactUid - ID
|
Internal id or email |
keyContactIds - [ID!]
|
Array of key contact ids or emails |
lawyerIds - [ID!]
|
Array of lawyer ids or emails |
messageReference - String
|
|
outcome - GoalOutcome
|
|
proposedFee - Float
|
|
receivedReferral - Boolean
|
|
referralSourceEmail - String
|
|
referralSourceId - ID
|
|
referralSourceUid - ID
|
Referral source id or email |
tags - [String!]
|
|
title - String
|
Example
{
"assignedToEmail": "abc123",
"assignedToId": "4",
"customFieldAttributes": [CustomFieldAttribute],
"customStatusId": 4,
"customStatusUid": 4,
"date": "abc123",
"description": "xyz789",
"documentUrls": ["xyz789"],
"emailBody": "abc123",
"internalContactUid": 4,
"keyContactIds": [4],
"lawyerIds": [4],
"messageReference": "abc123",
"outcome": "LOST",
"proposedFee": 987.65,
"receivedReferral": false,
"referralSourceEmail": "xyz789",
"referralSourceId": "4",
"referralSourceUid": "4",
"tags": ["xyz789"],
"title": "abc123"
}
CompanyGoalFiltering
Description
Options for filtering goals
Fields
| Input Field | Description |
|---|---|
companyUid - ID
|
|
customStatusId - ID
|
|
fromDate - ISO8601Date
|
|
involvedEmployeeUid - ID
|
with Employee by id |
messageReference - String
|
|
ownerUid - String
|
with owner id or email |
projectUid - ID
|
|
receivedReferral - Boolean
|
|
referralSource - String
|
|
term - String
|
|
timeFilters - [OpportunityTimeFilter!]
|
|
toDate - ISO8601Date
|
|
withEmployeeUid - ID
|
with Employee by id or email |
Example
{
"companyUid": 4,
"customStatusId": "4",
"fromDate": ISO8601Date,
"involvedEmployeeUid": "4",
"messageReference": "xyz789",
"ownerUid": "abc123",
"projectUid": 4,
"receivedReferral": false,
"referralSource": "abc123",
"term": "xyz789",
"timeFilters": [OpportunityTimeFilter],
"toDate": ISO8601Date,
"withEmployeeUid": 4
}
CompanyGrid
Fields
| Field Name | Description |
|---|---|
domain - String
|
|
id - ID!
|
|
industryNames - [String!]!
|
|
internalIndustryNames - [String!]!
|
|
logoUrl - String
|
|
monthlyEngagement - [CompanyMonthlyInteractionDist!]!
|
|
name - String!
|
|
typeName - String!
|
Use type_names |
typeNames - [String!]!
|
Example
{
"domain": "xyz789",
"id": "4",
"industryNames": ["abc123"],
"internalIndustryNames": ["abc123"],
"logoUrl": "xyz789",
"monthlyEngagement": [CompanyMonthlyInteractionDist],
"name": "abc123",
"typeName": "abc123",
"typeNames": ["xyz789"]
}
CompanyHierarchy
Example
{
"company": Company,
"customFields": [CustomField],
"hierarchy": Hierarchy,
"id": "4",
"level": 123,
"parent": Company,
"position": 123
}
CompanyHierarchyNodeFiltering
Fields
| Input Field | Description |
|---|---|
hierarchyUid - String
|
Filter by hierarchy id or hierarchy name |
Example
{"hierarchyUid": "xyz789"}
CompanyInfo
Fields
| Field Name | Description |
|---|---|
correspondenceEmails - [String!]
|
|
correspondenceNumbers - [String!]
|
|
description - String
|
|
headquarterLocation - CompanyOfficeLocation
|
|
id - ID
|
|
industryNames - [String!]
|
|
internalIndustries - [InternalIndustry!]
|
|
internalIndustryNames - [String!]
|
|
linkedinUrl - String
|
|
locations - [Location!]!
|
|
name - String!
|
|
numberOfEmployees - Int
|
|
primaryLocation - CompanyOfficeLocation
|
|
tags - [String!]!
|
|
twitterUrl - String
|
|
website - String
|
Example
{
"correspondenceEmails": ["abc123"],
"correspondenceNumbers": ["abc123"],
"description": "abc123",
"headquarterLocation": CompanyOfficeLocation,
"id": "4",
"industryNames": ["abc123"],
"internalIndustries": [InternalIndustry],
"internalIndustryNames": ["abc123"],
"linkedinUrl": "abc123",
"locations": [Location],
"name": "xyz789",
"numberOfEmployees": 123,
"primaryLocation": CompanyOfficeLocation,
"tags": ["xyz789"],
"twitterUrl": "abc123",
"website": "abc123"
}
CompanyInfoForCustomField
CompanyListAttributes
Fields
| Input Field | Description |
|---|---|
renderMode - RenderMode
|
Example
{"renderMode": "CLIENT_SIDE"}
CompanyListEntries
Fields
| Field Name | Description |
|---|---|
entries - [CompanyListItem!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [CompanyListItem],
"pageInfo": PagingInfo
}
CompanyListItem
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
creator - User!
|
|
discardedAt - ISO8601DateTime
|
|
id - ID!
|
|
memberCustomFields - [CustomFieldSchema!]
|
|
name - String!
|
|
project - Project
|
|
reminderSettings - [ReminderSetting!]!
|
|
tabUid - ID
|
|
updatedAt - ISO8601DateTime!
|
|
usageMode - CompanyUsageModeInput!
|
Example
{
"createdAt": ISO8601DateTime,
"creator": User,
"discardedAt": ISO8601DateTime,
"id": "4",
"memberCustomFields": [CustomFieldSchema],
"name": "abc123",
"project": Project,
"reminderSettings": [ReminderSetting],
"tabUid": "4",
"updatedAt": ISO8601DateTime,
"usageMode": "PERSONAL"
}
CompanyListMember
Fields
| Field Name | Description |
|---|---|
company - Company!
|
|
companyList - CompanyListItem!
|
|
companyListId - ID!
|
|
completedTasksCount - Int!
|
|
customFields - [CustomField!]!
|
Use gridCustomFields instead |
gridCustomFields - [CustomFieldGrid!]!
|
|
id - ID!
|
|
listReminders - [Reminder!]!
|
|
tasksCount - Int!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"company": Company,
"companyList": CompanyListItem,
"companyListId": 4,
"completedTasksCount": 987,
"customFields": [CustomField],
"gridCustomFields": [CustomFieldGrid],
"id": 4,
"listReminders": [Reminder],
"tasksCount": 987,
"updatedAt": ISO8601DateTime
}
CompanyListMembers
Fields
| Field Name | Description |
|---|---|
entries - [CompanyListMember!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [CompanyListMember],
"pageInfo": PagingInfo
}
CompanyMonthlyInteractionDist
CompanyNodeEntries
Fields
| Field Name | Description |
|---|---|
entries - [CompanyHierarchy!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [CompanyHierarchy],
"pageInfo": PagingInfo
}
CompanyNote
Fields
| Field Name | Description |
|---|---|
access - CompanyNoteAccess!
|
|
company - Company!
|
|
contact - Contact
|
|
content - RichContent!
|
|
createdAt - ISO8601DateTime!
|
|
creator - User
|
|
creatorName - String!
|
|
id - ID!
|
|
updatedAt - ISO8601DateTime!
|
|
updater - User
|
Example
{
"access": "CUSTOM",
"company": Company,
"contact": Contact,
"content": RichContent,
"createdAt": ISO8601DateTime,
"creator": User,
"creatorName": "xyz789",
"id": 4,
"updatedAt": ISO8601DateTime,
"updater": User
}
CompanyNoteAccess
Description
Manages access and visibilty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CUSTOM"
CompanyNoteList
Fields
| Field Name | Description |
|---|---|
entries - [CompanyNote!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [CompanyNote],
"pageInfo": PagingInfo
}
CompanyOfficeLocation
CompanyOfficeLocationGrid
Example
{
"brief": "abc123",
"city": "abc123",
"country": Country,
"isHeadquarter": true,
"isPrimary": true,
"postCode": "abc123",
"state": "abc123",
"streetAddress": "xyz789"
}
CompanyOfficeLocationList
Fields
| Field Name | Description |
|---|---|
entries - [CompanyOfficeLocation!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [CompanyOfficeLocation],
"pageInfo": PagingInfo
}
CompanySwitchKnownDetail
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NEXT_COMPANY_KNOWN"
CompanyTimeFilter
Description
Options for filtering by time
Fields
| Input Field | Description |
|---|---|
position - TimeFilterPosition!
|
|
property - CompanyTimeFilterProperty!
|
|
value - ISO8601DateTime!
|
Example
{
"position": "AFTER",
"property": "CREATED",
"value": ISO8601DateTime
}
CompanyTimeFilterProperty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREATED"
CompanyTypeDefault
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CLIENT"
CompanyUsageModeInput
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"PERSONAL"
CompleteClientCompaniesSyncMutationPayload
Description
Autogenerated return type of CompleteClientCompaniesSyncMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
CompleteMyTaskMutationPayload
Description
Autogenerated return type of CompleteMyTaskMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
CompositeFilterInput
Fields
| Input Field | Description |
|---|---|
compositeFilterUid - ID!
|
|
fields - [FieldConditionInput!]!
|
Example
{
"compositeFilterUid": "4",
"fields": [FieldConditionInput]
}
ConnectedList
Fields
| Field Name | Description |
|---|---|
campaignManager - CampaignManager
|
|
connected - Boolean
|
|
externalUrl - Url
|
|
id - String!
|
|
lastSyncAt - ISO8601DateTime
|
|
lastSyncError - String
|
|
list - List
|
|
mappings - [ConnectedListMapping!]!
|
|
nameOnEms - String
|
|
outOfSync - Boolean
|
|
syncing - Boolean!
|
Example
{
"campaignManager": CampaignManager,
"connected": false,
"externalUrl": Url,
"id": "xyz789",
"lastSyncAt": ISO8601DateTime,
"lastSyncError": "abc123",
"list": List,
"mappings": [ConnectedListMapping],
"nameOnEms": "xyz789",
"outOfSync": false,
"syncing": false
}
ConnectedListMapping
Fields
| Field Name | Description |
|---|---|
customFieldSchema - CustomFieldSchema
|
The form field to which the condition is applied |
id - ID!
|
ID of the mapping |
nexlFieldName - ContactFieldsForSync
|
The contact detail field name |
remoteCustomFieldSchemaUid - String
|
The remote custom field schema ID |
Example
{
"customFieldSchema": CustomFieldSchema,
"id": 4,
"nexlFieldName": "CITY",
"remoteCustomFieldSchemaUid": "xyz789"
}
ConnectionDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PULL"
ConnectorType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BREVO"
Contact
Fields
| Field Name | Description |
|---|---|
archivedAt - ISO8601DateTime
|
|
changedJob - Boolean!
|
|
company - Company!
|
|
contactCompanySwitch - ContactCompanySwitch
|
|
createdAt - ISO8601DateTime!
|
|
emailAddresses - [ContactEmailScalar!]!
|
|
id - ID!
|
|
inMyContacts - Boolean
|
|
info - ContactInfo!
|
|
interactionsIsEngaged - Boolean!
|
|
interactionsLast - LastAts!
|
|
interactionsTotal - Totals!
|
|
isActive - Boolean!
|
Use interactionsIsEngaged instead |
isArchived - Boolean!
|
|
isEmployee - Boolean!
|
|
isKeyContact - Boolean!
|
|
isPersonal - Boolean!
|
|
marketingListConsent - ContactConsent!
|
|
officeLocation - CompanyOfficeLocation
|
|
primaryEmail - ContactEmailScalar
|
|
unarchiveOnNextInteraction - Boolean
|
|
updatedAt - ISO8601DateTime
|
Example
{
"archivedAt": ISO8601DateTime,
"changedJob": false,
"company": Company,
"contactCompanySwitch": ContactCompanySwitch,
"createdAt": ISO8601DateTime,
"emailAddresses": ["[email protected]"],
"id": 4,
"inMyContacts": true,
"info": ContactInfo,
"interactionsIsEngaged": true,
"interactionsLast": LastAts,
"interactionsTotal": Totals,
"isActive": false,
"isArchived": true,
"isEmployee": true,
"isKeyContact": true,
"isPersonal": true,
"marketingListConsent": ContactConsent,
"officeLocation": CompanyOfficeLocation,
"primaryEmail": "[email protected]",
"unarchiveOnNextInteraction": true,
"updatedAt": ISO8601DateTime
}
ContactAttributes
Description
Attributes for contact
Fields
| Input Field | Description |
|---|---|
customFieldAttributes - [CustomFieldAttribute!]
|
|
department - String
|
|
educations - [String!]
|
|
firstName - String
|
|
jobTitle - String
|
|
lastName - String
|
|
linkedinUrl - String
|
|
locationAttributes - LocationAttributes
|
|
locationsAttributes - [LocationAttributes!]
|
DEPRECATED: Use location_attributes instead |
office - String
|
|
officeLocationId - ID
|
|
phoneNumbers - [String!]
|
|
phoneNumbersWithType - [PhoneNumberAttributes!]
|
|
tags - [String!]
|
|
twitterUrl - String
|
Example
{
"customFieldAttributes": [CustomFieldAttribute],
"department": "xyz789",
"educations": ["xyz789"],
"firstName": "abc123",
"jobTitle": "abc123",
"lastName": "xyz789",
"linkedinUrl": "xyz789",
"locationAttributes": LocationAttributes,
"locationsAttributes": [LocationAttributes],
"office": "xyz789",
"officeLocationId": "4",
"phoneNumbers": ["xyz789"],
"phoneNumbersWithType": [PhoneNumberAttributes],
"tags": ["abc123"],
"twitterUrl": "abc123"
}
ContactCard
Fields
| Field Name | Description |
|---|---|
archivedAt - ISO8601DateTime
|
|
company - CompanyGrid!
|
Deprecated: Use company_card instead. |
companyCard - CompanyCard!
|
|
companyDetail - CompanyDetail!
|
|
companyExternalIdentifier - ExternalIdentifier
|
|
companyKeyContactSince - ISO8601DateTime
|
|
companySwitchKnownDetail - CompanySwitchKnownDetail
|
|
contactId - ID!
|
|
contactLocation - Location
|
|
displayName - String
|
|
educations - GridStringArrayScalar
|
|
firstName - String
|
|
id - ID!
|
|
imageUrl - String!
|
|
isArchived - Boolean!
|
|
isBounced - Boolean
|
|
isInteractionsEngaged - Boolean!
|
|
jobTitle - String
|
|
lastInteractionAt - ISO8601DateTime
|
|
lastName - String
|
|
linkedinUrl - Url
|
|
phoneNumbers - GridStringArrayScalar
|
|
primaryEmail - ContactEmailScalar
|
|
tags - GridStringArrayScalar
|
|
twitterUrl - String
|
Example
{
"archivedAt": ISO8601DateTime,
"company": CompanyGrid,
"companyCard": CompanyCard,
"companyDetail": CompanyDetail,
"companyExternalIdentifier": ExternalIdentifier,
"companyKeyContactSince": ISO8601DateTime,
"companySwitchKnownDetail": "NEXT_COMPANY_KNOWN",
"contactId": "4",
"contactLocation": Location,
"displayName": "abc123",
"educations": GridStringArrayScalar,
"firstName": "abc123",
"id": 4,
"imageUrl": "xyz789",
"isArchived": true,
"isBounced": false,
"isInteractionsEngaged": true,
"jobTitle": "xyz789",
"lastInteractionAt": ISO8601DateTime,
"lastName": "xyz789",
"linkedinUrl": Url,
"phoneNumbers": GridStringArrayScalar,
"primaryEmail": ContactEmailScalar,
"tags": GridStringArrayScalar,
"twitterUrl": "abc123"
}
ContactCommunicationCondition
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANY"
ContactCompanySwitch
Fields
| Field Name | Description |
|---|---|
company - Company
|
Never implemented |
creator - User!
|
|
id - ID!
|
|
knownDetail - CompanySwitchKnownDetail
|
Example
{
"company": Company,
"creator": User,
"id": "4",
"knownDetail": "NEXT_COMPANY_KNOWN"
}
ContactConsent
Fields
| Field Name | Description |
|---|---|
autoChangedReason - String
|
|
howWasConsentGiven - String
|
|
id - String
|
|
status - ContactConsentStatus!
|
|
whenWasConsentGiven - ISO8601Date
|
Example
{
"autoChangedReason": "abc123",
"howWasConsentGiven": "abc123",
"id": "abc123",
"status": "CONSENT_GIVEN",
"whenWasConsentGiven": ISO8601Date
}
ContactConsentAttribute
Fields
| Input Field | Description |
|---|---|
howWasConsentGiven - String
|
|
status - ContactConsentStatus!
|
|
whenWasConsentGiven - ISO8601Date
|
Example
{
"howWasConsentGiven": "xyz789",
"status": "CONSENT_GIVEN",
"whenWasConsentGiven": ISO8601Date
}
ContactConsentStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONSENT_GIVEN"
ContactEmailScalar
Description
It handles the email address of a contact and returns the email address or original input value if the user is not restricted, otherwise it returns the email address with *** in the local part.
Example
ContactEmailScalar
ContactFieldsForSync
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CITY"
ContactFilter
Description
Options for filtering contacts
Fields
| Input Field | Description |
|---|---|
operator - FilterOperator!
|
|
property - ContactFilterProperty!
|
|
value - String
|
|
values - [String!]
|
Example
{
"operator": "CONTAINS",
"property": "CITY",
"value": "abc123",
"values": ["xyz789"]
}
ContactFilterProperty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CITY"
ContactForCustomField
Fields
| Field Name | Description |
|---|---|
company - Company!
|
|
id - ID!
|
|
info - ContactInfoForCustomField!
|
|
interactionsIsEngaged - Boolean!
|
|
isActive - Boolean!
|
Use interactionsIsEngaged instead |
isArchived - Boolean!
|
|
isKeyContact - Boolean!
|
|
primaryEmail - ContactEmailScalar
|
Example
{
"company": Company,
"id": 4,
"info": ContactInfoForCustomField,
"interactionsIsEngaged": false,
"isActive": false,
"isArchived": true,
"isKeyContact": true,
"primaryEmail": ContactEmailScalar
}
ContactGrid
Example
{
"city": "xyz789",
"company": CompanyGrid,
"country": "xyz789",
"firstName": "xyz789",
"id": 4,
"imageUrl": "xyz789",
"isActive": false,
"isArchived": true,
"isKeyContact": false,
"jobTitle": "xyz789",
"lastName": "xyz789",
"primaryEmail": ContactEmailScalar
}
ContactInfo
Fields
| Field Name | Description |
|---|---|
customFields - [CustomField!]
|
|
department - String
|
|
displayName - String!
|
|
educations - [String!]!
|
|
firstName - String
|
|
gender - String
|
|
id - ID
|
|
imageUrl - String
|
|
Arguments
|
|
jobTitle - String
|
|
lastName - String
|
|
linkedinUrl - Url
|
|
location - Location
|
|
office - String
|
|
phoneNumbers - [String!]!
|
|
phoneNumbersWithType - [PhoneNumber!]!
|
|
tags - [String!]!
|
|
twitterUrl - String
|
|
Example
{
"customFields": [CustomField],
"department": "abc123",
"displayName": "abc123",
"educations": ["abc123"],
"firstName": "abc123",
"gender": "abc123",
"id": "4",
"imageUrl": "xyz789",
"jobTitle": "xyz789",
"lastName": "xyz789",
"linkedinUrl": Url,
"location": Location,
"office": "abc123",
"phoneNumbers": ["xyz789"],
"phoneNumbersWithType": [PhoneNumber],
"tags": ["abc123"],
"twitterUrl": "abc123"
}
ContactInfoForCustomField
ContactJobTitle
Fields
| Field Name | Description |
|---|---|
endDate - ISO8601Date
|
|
id - ID!
|
|
name - String!
|
|
startDate - ISO8601Date
|
Example
{
"endDate": ISO8601Date,
"id": "4",
"name": "abc123",
"startDate": ISO8601Date
}
ContactList
Fields
| Field Name | Description |
|---|---|
entries - [Contact!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [Contact],
"pageInfo": PagingInfo
}
ContactListGridMember
Fields
| Field Name | Description |
|---|---|
addedBy - UserCard
|
|
completedTasksCount - Int!
|
|
contactCard - ContactCard!
|
|
contactCustomFields - [CustomFieldGrid!]!
|
|
contactId - ID!
|
|
contactInteractionsLast - LastAts
|
|
contactInteractionsTotal - Totals
|
|
createdAt - ISO8601DateTime!
|
|
customFields - [CustomFieldGrid!]!
|
|
id - ID!
|
|
inMyContacts - Boolean
|
|
listId - ID!
|
|
listReminders - [Reminder!]!
|
|
marketingListContactConsent - ContactConsent!
|
|
officeLocation - Location
|
|
tasksCount - Int!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"addedBy": UserCard,
"completedTasksCount": 123,
"contactCard": ContactCard,
"contactCustomFields": [CustomFieldGrid],
"contactId": "4",
"contactInteractionsLast": LastAts,
"contactInteractionsTotal": Totals,
"createdAt": ISO8601DateTime,
"customFields": [CustomFieldGrid],
"id": 4,
"inMyContacts": true,
"listId": 4,
"listReminders": [Reminder],
"marketingListContactConsent": ContactConsent,
"officeLocation": Location,
"tasksCount": 123,
"updatedAt": ISO8601DateTime
}
ContactTimeFilter
Description
Options for filtering by time
Fields
| Input Field | Description |
|---|---|
position - TimeFilterPosition!
|
|
property - ContactTimeFilterProperty!
|
|
value - ISO8601DateTime!
|
Example
{
"position": "AFTER",
"property": "CREATED",
"value": ISO8601DateTime
}
ContactTimeFilterProperty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREATED"
ContactsFiltering
Description
Filtering Options for contacts
Fields
| Input Field | Description |
|---|---|
belongToCompanyHierarchy - ID
|
Company uid |
companyRelationshipPartnerUids - [ID!]
|
|
companyTypeUids - [ID!]
|
|
companyUid - ID
|
|
consentStatuses - [ContactConsentStatus!]
|
|
contactUids - [ID!]
|
|
excludeExternal - Boolean
|
Use in conjunction with include_internal_contact=true to get all employees. Default = false |
groups - [GroupFilter!]
|
|
includeArchived - Boolean
|
Include archived contacts. Default = false |
includeInternalContact - Boolean
|
|
keyActivityDescription - String
|
|
keyActivityTitles - [String!]
|
|
knowByUids - [ID!]
|
|
missingKeyData - Boolean
|
|
term - String
|
|
timeFilters - [ContactTimeFilter!]
|
|
withBouncedEmails - Boolean
|
|
withCustomField - [CustomFieldTerm!]
|
|
withJobChanges - Boolean
|
When set to true, only returns contacts who have changed jobs. Default = false |
Example
{
"belongToCompanyHierarchy": 4,
"companyRelationshipPartnerUids": ["4"],
"companyTypeUids": ["4"],
"companyUid": 4,
"consentStatuses": ["CONSENT_GIVEN"],
"contactUids": [4],
"excludeExternal": true,
"groups": [GroupFilter],
"includeArchived": false,
"includeInternalContact": false,
"keyActivityDescription": "xyz789",
"keyActivityTitles": ["abc123"],
"knowByUids": [4],
"missingKeyData": true,
"term": "abc123",
"timeFilters": [ContactTimeFilter],
"withBouncedEmails": true,
"withCustomField": [CustomFieldTerm],
"withJobChanges": true
}
ContactsOrderBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANY_NAME_ASC"
Country
Description
Country information
Fields
| Field Name | Description |
|---|---|
code - CountryCode!
|
|
emojiFlag - String!
|
|
name - String!
|
Example
{
"code": "AD",
"emojiFlag": "abc123",
"name": "xyz789"
}
CountryCode
Description
Alpha 2 code representing a country
Values
| Enum Value | Description |
|---|---|
|
|
Andorra |
|
|
United Arab Emirates |
|
|
Afghanistan |
|
|
Antigua and Barbuda |
|
|
Anguilla |
|
|
Albania |
|
|
Armenia |
|
|
Angola |
|
|
Antarctica |
|
|
Argentina |
|
|
American Samoa |
|
|
Austria |
|
|
Australia |
|
|
Aruba |
|
|
Åland Islands |
|
|
Azerbaijan |
|
|
Bosnia and Herzegovina |
|
|
Barbados |
|
|
Bangladesh |
|
|
Belgium |
|
|
Burkina Faso |
|
|
Bulgaria |
|
|
Bahrain |
|
|
Burundi |
|
|
Benin |
|
|
Saint Barthélemy |
|
|
Bermuda |
|
|
Brunei Darussalam |
|
|
Bolivia |
|
|
Bonaire, Sint Eustatius and Saba |
|
|
Brazil |
|
|
Bahamas |
|
|
Bhutan |
|
|
Bouvet Island |
|
|
Botswana |
|
|
Belarus |
|
|
Belize |
|
|
Canada |
|
|
Cocos (Keeling) Islands |
|
|
Congo, The Democratic Republic of the |
|
|
Central African Republic |
|
|
Congo |
|
|
Switzerland |
|
|
Côte d'Ivoire |
|
|
Cook Islands |
|
|
Chile |
|
|
Cameroon |
|
|
China |
|
|
Colombia |
|
|
Costa Rica |
|
|
Cuba |
|
|
Cabo Verde |
|
|
Curaçao |
|
|
Christmas Island |
|
|
Cyprus |
|
|
Czechia |
|
|
Germany |
|
|
Djibouti |
|
|
Denmark |
|
|
Dominica |
|
|
Dominican Republic |
|
|
Algeria |
|
|
Ecuador |
|
|
Estonia |
|
|
Egypt |
|
|
Western Sahara |
|
|
Eritrea |
|
|
Spain |
|
|
Ethiopia |
|
|
Finland |
|
|
Fiji |
|
|
Falkland Islands (Malvinas) |
|
|
Micronesia, Federated States of |
|
|
Faroe Islands |
|
|
France |
|
|
Gabon |
|
|
United Kingdom |
|
|
Grenada |
|
|
Georgia |
|
|
French Guiana |
|
|
Guernsey |
|
|
Ghana |
|
|
Gibraltar |
|
|
Greenland |
|
|
Gambia |
|
|
Guinea |
|
|
Guadeloupe |
|
|
Equatorial Guinea |
|
|
Greece |
|
|
South Georgia and the South Sandwich Islands |
|
|
Guatemala |
|
|
Guam |
|
|
Guinea-Bissau |
|
|
Guyana |
|
|
Hong Kong |
|
|
Heard Island and McDonald Islands |
|
|
Honduras |
|
|
Croatia |
|
|
Haiti |
|
|
Hungary |
|
|
Indonesia |
|
|
Ireland |
|
|
Israel |
|
|
Isle of Man |
|
|
India |
|
|
British Indian Ocean Territory |
|
|
Iraq |
|
|
Iran |
|
|
Iceland |
|
|
Italy |
|
|
Jersey |
|
|
Jamaica |
|
|
Jordan |
|
|
Japan |
|
|
Kenya |
|
|
Kyrgyzstan |
|
|
Cambodia |
|
|
Kiribati |
|
|
Comoros |
|
|
Saint Kitts and Nevis |
|
|
North Korea |
|
|
South Korea |
|
|
Kuwait |
|
|
Cayman Islands |
|
|
Kazakhstan |
|
|
Lao People's Democratic Republic |
|
|
Lebanon |
|
|
Saint Lucia |
|
|
Liechtenstein |
|
|
Sri Lanka |
|
|
Liberia |
|
|
Lesotho |
|
|
Lithuania |
|
|
Luxembourg |
|
|
Latvia |
|
|
Libya |
|
|
Morocco |
|
|
Monaco |
|
|
Moldova |
|
|
Montenegro |
|
|
Saint Martin (French part) |
|
|
Madagascar |
|
|
Marshall Islands |
|
|
North Macedonia |
|
|
Mali |
|
|
Myanmar |
|
|
Mongolia |
|
|
Macao |
|
|
Northern Mariana Islands |
|
|
Martinique |
|
|
Mauritania |
|
|
Montserrat |
|
|
Malta |
|
|
Mauritius |
|
|
Maldives |
|
|
Malawi |
|
|
Mexico |
|
|
Malaysia |
|
|
Mozambique |
|
|
Namibia |
|
|
New Caledonia |
|
|
Niger |
|
|
Norfolk Island |
|
|
Nigeria |
|
|
Nicaragua |
|
|
Netherlands |
|
|
Norway |
|
|
Nepal |
|
|
Nauru |
|
|
Niue |
|
|
New Zealand |
|
|
Oman |
|
|
Panama |
|
|
Peru |
|
|
French Polynesia |
|
|
Papua New Guinea |
|
|
Philippines |
|
|
Pakistan |
|
|
Poland |
|
|
Saint Pierre and Miquelon |
|
|
Pitcairn |
|
|
Puerto Rico |
|
|
Palestine, State of |
|
|
Portugal |
|
|
Palau |
|
|
Paraguay |
|
|
Qatar |
|
|
Réunion |
|
|
Romania |
|
|
Serbia |
|
|
Russian Federation |
|
|
Rwanda |
|
|
Saudi Arabia |
|
|
Solomon Islands |
|
|
Seychelles |
|
|
Sudan |
|
|
Sweden |
|
|
Singapore |
|
|
Saint Helena, Ascension and Tristan da Cunha |
|
|
Slovenia |
|
|
Svalbard and Jan Mayen |
|
|
Slovakia |
|
|
Sierra Leone |
|
|
San Marino |
|
|
Senegal |
|
|
Somalia |
|
|
Suriname |
|
|
South Sudan |
|
|
Sao Tome and Principe |
|
|
El Salvador |
|
|
Sint Maarten (Dutch part) |
|
|
Syrian Arab Republic |
|
|
Eswatini |
|
|
Turks and Caicos Islands |
|
|
Chad |
|
|
French Southern Territories |
|
|
Togo |
|
|
Thailand |
|
|
Tajikistan |
|
|
Tokelau |
|
|
Timor-Leste |
|
|
Turkmenistan |
|
|
Tunisia |
|
|
Tonga |
|
|
Türkiye |
|
|
Trinidad and Tobago |
|
|
Tuvalu |
|
|
Taiwan |
|
|
Tanzania |
|
|
Ukraine |
|
|
Uganda |
|
|
United States Minor Outlying Islands |
|
|
United States |
|
|
Uruguay |
|
|
Uzbekistan |
|
|
Holy See (Vatican City State) |
|
|
Saint Vincent and the Grenadines |
|
|
Venezuela |
|
|
Virgin Islands, British |
|
|
Virgin Islands, U.S. |
|
|
Vietnam |
|
|
Vanuatu |
|
|
Wallis and Futuna |
|
|
Samoa |
|
|
Yemen |
|
|
Mayotte |
|
|
South Africa |
|
|
Zambia |
|
|
Zimbabwe |
Example
"AD"
CreateCampaignMutationPayload
Description
Autogenerated return type of CreateCampaignMutation.
Fields
| Field Name | Description |
|---|---|
campaign - Campaign
|
|
failReasons - [String!]!
|
Example
{
"campaign": Campaign,
"failReasons": ["abc123"]
}
CreateCompanyContactMutationPayload
Description
Autogenerated return type of CreateCompanyContactMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
uid - ID
|
Example
{
"failReasons": ["abc123"],
"uid": "4"
}
CreateCompanyKeyContactMutationPayload
Description
Autogenerated return type of CreateCompanyKeyContactMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
CreateCompanyListCustomFieldSchemaMutationPayload
Description
Autogenerated return type of CreateCompanyListCustomFieldSchemaMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - CustomFieldSchema
|
Example
{
"failReasons": ["xyz789"],
"record": CustomFieldSchema
}
CreateCompanyMutationPayload
Description
Autogenerated return type of CreateCompanyMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
uid - ID
|
Example
{"failReasons": ["xyz789"], "uid": 4}
CreateCompanyNoteMutationPayload
Description
Autogenerated return type of CreateCompanyNoteMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
id - ID
|
Example
{
"failReasons": ["abc123"],
"id": "4"
}
CreateCompanyRelationshipPartnerMutationPayload
Description
Autogenerated return type of CreateCompanyRelationshipPartnerMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
relationshipPartnerCreated - RelationshipPartner
|
Example
{
"failReasons": ["xyz789"],
"relationshipPartnerCreated": RelationshipPartner
}
CreateContactListWebhookMutationPayload
Description
Autogenerated return type of CreateContactListWebhookMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - WebhookTrigger
|
Example
{
"failReasons": ["abc123"],
"record": WebhookTrigger
}
CreateContactMutationPayload
Description
Autogenerated return type of CreateContactMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - Contact
|
|
uid - ID
|
Use record { id } instead
|
Example
{
"failReasons": ["abc123"],
"record": Contact,
"uid": 4
}
CreateEmbedUrlTabMutationPayload
Description
Autogenerated return type of CreateEmbedUrlTabMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
id - ID
|
Example
{"failReasons": ["xyz789"], "id": 4}
CreateGenericListItemMutationPayload
Description
Autogenerated return type of CreateGenericListItemMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - GenericListItem
|
Example
{
"failReasons": ["xyz789"],
"record": GenericListItem
}
CreateGenericListWebhookMutationPayload
Description
Autogenerated return type of CreateGenericListWebhookMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - WebhookTrigger
|
Example
{
"failReasons": ["xyz789"],
"record": WebhookTrigger
}
CreateInternalIndustryMutationPayload
Description
Autogenerated return type of CreateInternalIndustryMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
id - ID
|
Example
{
"failReasons": ["xyz789"],
"id": "4"
}
CreateKeyActivitiesMutationPayload
Description
Autogenerated return type of CreateKeyActivitiesMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
CreateListCustomFieldSchemaMutationPayload
Description
Autogenerated return type of CreateListCustomFieldSchemaMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - CustomFieldSchema
|
Example
{
"failReasons": ["abc123"],
"record": CustomFieldSchema
}
CreateMarketingContactListMutationPayload
Description
Autogenerated return type of CreateMarketingContactListMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - List
|
Example
{
"failReasons": ["xyz789"],
"record": List
}
CreateOfficeLocationMutationPayload
Description
Autogenerated return type of CreateOfficeLocationMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
CreateProjectFromTemplateMutationPayload
Description
Autogenerated return type of CreateProjectFromTemplateMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - Project
|
Example
{
"failReasons": ["abc123"],
"record": Project
}
CreateProjectMutationPayload
Description
Autogenerated return type of CreateProjectMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - Project
|
Example
{
"failReasons": ["xyz789"],
"record": Project
}
CreateSentReferralMutationPayload
Description
Autogenerated return type of CreateSentReferralMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - SentReferral
|
Example
{
"failReasons": ["xyz789"],
"record": SentReferral
}
CreateStaticCompanyListTabMutationPayload
Description
Autogenerated return type of CreateStaticCompanyListTabMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
id - ID
|
|
record - TabResult
|
Example
{
"failReasons": ["xyz789"],
"id": 4,
"record": TabResult
}
CreateTaskAttributes
Fields
| Input Field | Description |
|---|---|
description - String
|
|
dueOn - String
|
|
priority - PriorityEnum
|
|
title - String!
|
Example
{
"description": "xyz789",
"dueOn": "xyz789",
"priority": "critical",
"title": "xyz789"
}
CreateTaskMutationPayload
Description
Autogenerated return type of CreateTaskMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - Task
|
Example
{
"failReasons": ["xyz789"],
"record": Task
}
CreateUserDelegateAccessMutationPayload
Description
Autogenerated return type of CreateUserDelegateAccessMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
CreateWebhookMutationPayload
Description
Autogenerated return type of CreateWebhookMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - WebhookTrigger!
|
Example
{
"failReasons": ["abc123"],
"record": WebhookTrigger
}
Currency
Description
Currency information
Example
{
"decimalMark": "xyz789",
"exponent": 987,
"isoCode": "AED",
"name": "xyz789",
"symbol": "xyz789",
"symbolFirst": true,
"thousandsSeparator": "abc123"
}
CurrencyCode
Description
Currency iso code
Values
| Enum Value | Description |
|---|---|
|
|
United Arab Emirates Dirham |
|
|
Afghan Afghani |
|
|
Albanian Lek |
|
|
Armenian Dram |
|
|
Netherlands Antillean Gulden |
|
|
Angolan Kwanza |
|
|
Argentine Peso |
|
|
Australian Dollar |
|
|
Aruban Florin |
|
|
Azerbaijani Manat |
|
|
Bosnia and Herzegovina Convertible Mark |
|
|
Barbadian Dollar |
|
|
Bitcoin Cash |
|
|
Bangladeshi Taka |
|
|
Bulgarian Lev |
|
|
Bahraini Dinar |
|
|
Burundian Franc |
|
|
Bermudian Dollar |
|
|
Brunei Dollar |
|
|
Bolivian Boliviano |
|
|
Brazilian Real |
|
|
Bahamian Dollar |
|
|
Bitcoin |
|
|
Bhutanese Ngultrum |
|
|
Botswana Pula |
|
|
Belarusian Ruble |
|
|
Belarusian Ruble |
|
|
Belize Dollar |
|
|
Canadian Dollar |
|
|
Congolese Franc |
|
|
Swiss Franc |
|
|
Unidad de Fomento |
|
|
Chilean Peso |
|
|
Chinese Renminbi Yuan Offshore |
|
|
Chinese Renminbi Yuan |
|
|
Colombian Peso |
|
|
Costa Rican Colón |
|
|
Cuban Convertible Peso |
|
|
Cuban Peso |
|
|
Cape Verdean Escudo |
|
|
Czech Koruna |
|
|
Djiboutian Franc |
|
|
Danish Krone |
|
|
Dominican Peso |
|
|
Algerian Dinar |
|
|
Estonian Kroon |
|
|
Egyptian Pound |
|
|
Eritrean Nakfa |
|
|
Ethiopian Birr |
|
|
Euro |
|
|
Fijian Dollar |
|
|
Falkland Pound |
|
|
British Pound |
|
|
British Penny |
|
|
Georgian Lari |
|
|
Guernsey Pound |
|
|
Ghanaian Cedi |
|
|
Gibraltar Pound |
|
|
Gambian Dalasi |
|
|
Guinean Franc |
|
|
Guatemalan Quetzal |
|
|
Guyanese Dollar |
|
|
Hong Kong Dollar |
|
|
Honduran Lempira |
|
|
Croatian Kuna |
|
|
Haitian Gourde |
|
|
Hungarian Forint |
|
|
Indonesian Rupiah |
|
|
Israeli New Sheqel |
|
|
Isle of Man Pound |
|
|
Indian Rupee |
|
|
Iraqi Dinar |
|
|
Iranian Rial |
|
|
Icelandic Króna |
|
|
Jersey Pound |
|
|
Jamaican Dollar |
|
|
Jordanian Dinar |
|
|
Japanese Yen |
|
|
Kenyan Shilling |
|
|
Kyrgyzstani Som |
|
|
Cambodian Riel |
|
|
Comorian Franc |
|
|
North Korean Won |
|
|
South Korean Won |
|
|
Kuwaiti Dinar |
|
|
Cayman Islands Dollar |
|
|
Kazakhstani Tenge |
|
|
Lao Kip |
|
|
Lebanese Pound |
|
|
Sri Lankan Rupee |
|
|
Liberian Dollar |
|
|
Lesotho Loti |
|
|
Lithuanian Litas |
|
|
Latvian Lats |
|
|
Libyan Dinar |
|
|
Moroccan Dirham |
|
|
Moldovan Leu |
|
|
Malagasy Ariary |
|
|
Macedonian Denar |
|
|
Myanmar Kyat |
|
|
Mongolian Tögrög |
|
|
Macanese Pataca |
|
|
Mauritanian Ouguiya |
|
|
Mauritanian Ouguiya |
|
|
Maltese Lira |
|
|
Mauritian Rupee |
|
|
Maldivian Rufiyaa |
|
|
Malawian Kwacha |
|
|
Mexican Peso |
|
|
Malaysian Ringgit |
|
|
Mozambican Metical |
|
|
Namibian Dollar |
|
|
Nigerian Naira |
|
|
Nicaraguan Córdoba |
|
|
Norwegian Krone |
|
|
Nepalese Rupee |
|
|
New Zealand Dollar |
|
|
Omani Rial |
|
|
Panamanian Balboa |
|
|
Peruvian Sol |
|
|
Papua New Guinean Kina |
|
|
Philippine Peso |
|
|
Pakistani Rupee |
|
|
Polish Złoty |
|
|
Paraguayan Guaraní |
|
|
Qatari Riyal |
|
|
Romanian Leu |
|
|
Serbian Dinar |
|
|
Russian Ruble |
|
|
Rwandan Franc |
|
|
Saudi Riyal |
|
|
Solomon Islands Dollar |
|
|
Seychellois Rupee |
|
|
Sudanese Pound |
|
|
Swedish Krona |
|
|
Singapore Dollar |
|
|
Saint Helenian Pound |
|
|
Slovak Koruna |
|
|
New Leone |
|
|
Sierra Leonean Leone |
|
|
Somali Shilling |
|
|
Surinamese Dollar |
|
|
South Sudanese Pound |
|
|
São Tomé and Príncipe Dobra |
|
|
São Tomé and Príncipe Second Dobra |
|
|
Salvadoran Colón |
|
|
Syrian Pound |
|
|
Swazi Lilangeni |
|
|
Thai Baht |
|
|
Tajikistani Somoni |
|
|
Turkmenistani Manat |
|
|
Turkmenistani Manat |
|
|
Tunisian Dinar |
|
|
Tongan Paʻanga |
|
|
Turkish Lira |
|
|
Trinidad and Tobago Dollar |
|
|
New Taiwan Dollar |
|
|
Tanzanian Shilling |
|
|
Ukrainian Hryvnia |
|
|
Ugandan Shilling |
|
|
United States Dollar |
|
|
USD Coin |
|
|
Uruguayan Peso |
|
|
Uzbekistan Som |
|
|
Venezuelan Bolívar |
|
|
Venezuelan Bolívar Soberano |
|
|
Vietnamese Đồng |
|
|
Vanuatu Vatu |
|
|
Samoan Tala |
|
|
Central African Cfa Franc |
|
|
Silver (Troy Ounce) |
|
|
Gold (Troy Ounce) |
|
|
European Composite Unit |
|
|
European Monetary Unit |
|
|
European Unit of Account 9 |
|
|
European Unit of Account 17 |
|
|
East Caribbean Dollar |
|
|
Special Drawing Rights |
|
|
UIC Franc |
|
|
West African Cfa Franc |
|
|
Palladium |
|
|
Cfp Franc |
|
|
Platinum |
|
|
Codes specifically reserved for testing purposes |
|
|
Yemeni Rial |
|
|
South African Rand |
|
|
Zambian Kwacha |
|
|
Zambian Kwacha |
|
|
Zimbabwean Dollar |
|
|
Zimbabwean Dollar |
|
|
Zimbabwean Dollar |
|
|
Zimbabwean Dollar |
Example
"AED"
CustomCurrencyFieldGrid
Fields
| Field Name | Description |
|---|---|
amount - Money
|
Example
{"amount": Money}
CustomDatetimeFieldGrid
Fields
| Field Name | Description |
|---|---|
date - ISO8601Date
|
Example
{"date": ISO8601Date}
CustomEmployeeFieldGrid
Fields
| Field Name | Description |
|---|---|
employee - EmployeeGrid
|
Example
{"employee": EmployeeGrid}
CustomField
Description
Company goal custom fields
Fields
| Field Name | Description |
|---|---|
currency - Currency
|
|
id - ID!
|
|
name - String!
|
|
schemaId - ID!
|
|
stringValue - String!
|
|
value - CustomFieldValue
|
|
valueTypeEnum - CustomFieldSchemaValue
|
Example
{
"currency": Currency,
"id": "4",
"name": "abc123",
"schemaId": 4,
"stringValue": "xyz789",
"value": CustomFieldCompany,
"valueTypeEnum": "CURRENCY"
}
CustomFieldAttribute
Fields
| Input Field | Description |
|---|---|
jsonValue - CustomValueStringScalar
|
|
name - String
|
|
schemaId - ID
|
|
updateMode - CustomFieldUpdateModeEnum
|
|
value - JSON
|
Example
{
"jsonValue": CustomValueStringScalar,
"name": "abc123",
"schemaId": 4,
"updateMode": "ADD",
"value": {}
}
CustomFieldCompany
Fields
| Field Name | Description |
|---|---|
companies - [CompanyForCustomField!]
|
Example
{"companies": [CompanyForCustomField]}
CustomFieldContact
Fields
| Field Name | Description |
|---|---|
contacts - [ContactForCustomField!]
|
Example
{"contacts": [ContactForCustomField]}
CustomFieldDate
Fields
| Field Name | Description |
|---|---|
dateValue - ISO8601Date
|
Example
{"dateValue": ISO8601Date}
CustomFieldEmployee
Fields
| Field Name | Description |
|---|---|
employee - EmployeeForCustomField
|
Example
{"employee": EmployeeForCustomField}
CustomFieldFullDateTime
Fields
| Field Name | Description |
|---|---|
dateTime - ISO8601DateTime
|
Example
{"dateTime": ISO8601DateTime}
CustomFieldGrid
Description
Opportunity custom fields
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
schemaId - ID!
|
|
schemaValueType - CustomFieldSchemaValue!
|
|
stringValue - String
|
|
value - CustomFieldGridValueUnion
|
Example
{
"id": 4,
"name": "abc123",
"schemaId": "4",
"schemaValueType": "CURRENCY",
"stringValue": "abc123",
"value": CustomCurrencyFieldGrid
}
CustomFieldGridValueUnion
Types
| Union Types |
|---|
Example
CustomCurrencyFieldGrid
CustomFieldMoney
Fields
| Field Name | Description |
|---|---|
moneyValue - Money
|
Example
{"moneyValue": Money}
CustomFieldMulti
Fields
| Field Name | Description |
|---|---|
multiOption - [Option!]
|
Example
{"multiOption": [Option]}
CustomFieldMultiCountry
Fields
| Field Name | Description |
|---|---|
countries - [Country!]
|
Example
{"countries": [Country]}
CustomFieldMultiEmployee
Fields
| Field Name | Description |
|---|---|
employees - [EmployeeForCustomField!]
|
Example
{"employees": [EmployeeForCustomField]}
CustomFieldNumber
Fields
| Field Name | Description |
|---|---|
numberValue - BigInt
|
Example
{"numberValue": {}}
CustomFieldOptional
Fields
| Field Name | Description |
|---|---|
option - Option
|
Example
{"option": Option}
CustomFieldRichText
Fields
| Field Name | Description |
|---|---|
richContent - RichContent!
|
Example
{"richContent": RichContent}
CustomFieldSchema
Fields
| Field Name | Description |
|---|---|
campaigns - [Campaign!]
|
|
creator - UserInfo
|
|
currency - Currency
|
|
hideFromForm - Boolean!
|
|
id - String!
|
|
name - String!
|
|
optionChoices - [OptionChoice!]
|
|
position - Int!
|
|
schemaId - String!
|
|
searchable - Boolean
|
|
sortChoicesAlphabetically - Boolean!
|
|
usage - CustomFieldSchemaUsage!
|
|
valueTypeEnum - CustomFieldSchemaValue!
|
Example
{
"campaigns": [Campaign],
"creator": UserInfo,
"currency": Currency,
"hideFromForm": false,
"id": "xyz789",
"name": "xyz789",
"optionChoices": [OptionChoice],
"position": 123,
"schemaId": "xyz789",
"searchable": true,
"sortChoicesAlphabetically": false,
"usage": "DEFAULT",
"valueTypeEnum": "CURRENCY"
}
CustomFieldSchemaAttributes
Fields
| Input Field | Description |
|---|---|
currencyCode - CurrencyCode
|
|
name - String
|
|
options - [OptionsAttributes!]
|
|
valueType - CustomFieldSchemaValue
|
Example
{
"currencyCode": "AED",
"name": "abc123",
"options": [OptionsAttributes],
"valueType": "CURRENCY"
}
CustomFieldSchemaOwner
Description
What type of object the custom field is associated with
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONTACT"
CustomFieldSchemaUsage
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DEFAULT"
CustomFieldSchemaValue
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CURRENCY"
CustomFieldSchemasList
Fields
| Field Name | Description |
|---|---|
entries - [CustomFieldSchema!]!
|
Example
{"entries": [CustomFieldSchema]}
CustomFieldSelectSearchFilter
Fields
| Input Field | Description |
|---|---|
operator - SelectSearchOperator!
|
|
property - String!
|
|
values - [String!]
|
Example
{
"operator": "IS",
"property": "xyz789",
"values": ["abc123"]
}
CustomFieldString
Fields
| Field Name | Description |
|---|---|
stringValue - String
|
Example
{"stringValue": "abc123"}
CustomFieldTerm
CustomFieldTextSearchFilter
Fields
| Input Field | Description |
|---|---|
operator - TextSearchOperator!
|
|
property - String!
|
|
values - [String!]
|
Example
{
"operator": "CONTAINS",
"property": "xyz789",
"values": ["xyz789"]
}
CustomFieldTimeRange
Fields
| Field Name | Description |
|---|---|
timeRange - TimeRange
|
Example
{"timeRange": TimeRange}
CustomFieldUpdateModeEnum
Values
| Enum Value | Description |
|---|---|
|
|
Add values to existing |
|
|
Clear all values |
|
|
Remove specified values |
|
|
Replace all existing values |
Example
"ADD"
CustomFieldValue
Description
Custom Field Value
Example
CustomFieldCompany
CustomFullDateTimeFieldGrid
Fields
| Field Name | Description |
|---|---|
dateTime - ISO8601DateTime
|
Example
{"dateTime": ISO8601DateTime}
CustomMultiCompanyFieldGrid
Fields
| Field Name | Description |
|---|---|
companies - [CompanyGrid!]!
|
|
companyCards - [CompanyCard!]!
|
|
companyDetails - [CompanyDetail!]!
|
Example
{
"companies": [CompanyGrid],
"companyCards": [CompanyCard],
"companyDetails": [CompanyDetail]
}
CustomMultiContactFieldGrid
Fields
| Field Name | Description |
|---|---|
contactCards - [ContactCard!]!
|
|
contacts - [ContactGrid!]!
|
Example
{
"contactCards": [ContactCard],
"contacts": [ContactGrid]
}
CustomMultiCountryFieldGrid
Fields
| Field Name | Description |
|---|---|
countries - [Country!]!
|
Example
{"countries": [Country]}
CustomMultiEmployeeFieldGrid
Fields
| Field Name | Description |
|---|---|
employees - [EmployeeGrid!]!
|
Example
{"employees": [EmployeeGrid]}
CustomMultiOptionalValueFieldGrid
Fields
| Field Name | Description |
|---|---|
selected - [Option!]!
|
Example
{"selected": [Option]}
CustomNewlyDefinedFieldGrid
Fields
| Field Name | Description |
|---|---|
customableId - String
|
Example
{"customableId": "xyz789"}
CustomNumberFieldGrid
CustomObjectsField
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
templateField - DataTemplateField!
|
Example
{
"id": "4",
"templateField": DataTemplateField
}
CustomObjectsRecordList
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
template - DataTemplate!
|
Example
{
"id": 4,
"name": "abc123",
"template": DataTemplate
}
CustomOptionalValueFieldGrid
Fields
| Field Name | Description |
|---|---|
selected - Option
|
Example
{"selected": Option}
CustomRichTextFieldGrid
CustomTextFieldGrid
Fields
| Field Name | Description |
|---|---|
text - String
|
Example
{"text": "xyz789"}
CustomValueStringScalar
Description
A valid string or json array string
Example
CustomValueStringScalar
DataTemplate
Fields
| Field Name | Description |
|---|---|
canCreate - Boolean!
|
Whether the current user can create records for this template |
columns - [DataTemplateColumn!]!
|
|
companyDisplayEnabled - Boolean!
|
Whether this template displays on the company slider/page |
companyDisplayLabel - String
|
Label for the tab or section on the company slider/page |
companyDisplayMode - TemplateCompanyDisplayModeEnum
|
Company display mode (tab or section) |
contactSliderDisplayMode - TemplateContactSliderDisplayModeEnum
|
Contact slider display mode (tab or section) |
contactSliderEnabled - Boolean!
|
Whether this template displays on the contact slider |
contactSliderLabel - String
|
Label for the tab or section on the contact slider |
currentUserVisibility - DataTemplatePermissionVisibilityEnum!
|
The current user's visibility level for this template (ALL, MY, or NONE) |
employeeDisplayEnabled - Boolean!
|
Whether this template displays on the contact slider for employee contacts |
employeeDisplayLabel - String
|
Label for the tab or section header for employee contacts |
employeeDisplayMode - TemplateEmployeeDisplayModeEnum
|
Employee display mode (tab or section) |
fields - [CustomObjectsField!]!
|
|
hasWriteAccess - Boolean!
|
Whether the current user has write access |
id - ID!
|
|
name - String!
|
|
pluralName - String!
|
|
singularName - String!
|
|
title - String!
|
Use pluralName instead |
Example
{
"canCreate": true,
"columns": [DataTemplateColumn],
"companyDisplayEnabled": false,
"companyDisplayLabel": "xyz789",
"companyDisplayMode": "SECTION",
"contactSliderDisplayMode": "SECTION",
"contactSliderEnabled": false,
"contactSliderLabel": "abc123",
"currentUserVisibility": "ALL",
"employeeDisplayEnabled": false,
"employeeDisplayLabel": "xyz789",
"employeeDisplayMode": "SECTION",
"fields": [CustomObjectsField],
"hasWriteAccess": true,
"id": "4",
"name": "abc123",
"pluralName": "xyz789",
"singularName": "abc123",
"title": "abc123"
}
DataTemplateColumn
Fields
| Field Name | Description |
|---|---|
filterOperations - [ColumnFilterOperationEnum!]!
|
|
headerName - String!
|
|
id - ID!
|
|
initialHide - Boolean!
|
|
sortable - Boolean!
|
|
templateFieldType - TemplateFieldType!
|
Example
{
"filterOperations": ["BLANK"],
"headerName": "abc123",
"id": 4,
"initialHide": true,
"sortable": false,
"templateFieldType": "ANOTHER_DATA_RECORD"
}
DataTemplateField
Fields
| Field Name | Description |
|---|---|
associationType - TemplateFieldAssociationTypeEnum
|
|
createdAt - ISO8601DateTime!
|
|
currency - String
|
|
fieldType - TemplateFieldType!
|
|
id - ID!
|
|
multiple - Boolean!
|
|
name - String!
|
|
options - [String!]!
|
|
uniqueAssociations - Boolean!
|
Example
{
"associationType": "COMPANY",
"createdAt": ISO8601DateTime,
"currency": "abc123",
"fieldType": "ANOTHER_DATA_RECORD",
"id": "4",
"multiple": false,
"name": "abc123",
"options": ["xyz789"],
"uniqueAssociations": true
}
DataTemplatePermissionVisibilityEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
DateContactSearchFilter
Fields
| Input Field | Description |
|---|---|
operator - DateSearchOperator!
|
|
property - DateContactSearchableProperty!
|
|
values - [String!]!
|
Example
{
"operator": "BETWEEN",
"property": "CREATED_DATE",
"values": ["xyz789"]
}
DateContactSearchableProperty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREATED_DATE"
DateRangeInput
Fields
| Input Field | Description |
|---|---|
finish - ISO8601DateTime!
|
|
start - ISO8601DateTime!
|
Example
{
"finish": ISO8601DateTime,
"start": ISO8601DateTime
}
DateSearchOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BETWEEN"
DeleteMyTaskMutationPayload
Description
Autogenerated return type of DeleteMyTaskMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
task - MyTask
|
Example
{
"failReasons": ["xyz789"],
"task": MyTask
}
DeleteSentReferralMutationPayload
Description
Autogenerated return type of DeleteSentReferralMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
DeleteUserDelegateAccessMutationPayload
Description
Autogenerated return type of DeleteUserDelegateAccessMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
Department
Fields
| Field Name | Description |
|---|---|
employees - [Employee!]!
|
|
Arguments
|
|
id - ID!
|
|
name - String!
|
|
Example
{
"employees": [Employee],
"id": "4",
"name": "abc123"
}
DeploymentInfo
Fields
| Field Name | Description |
|---|---|
releaseCreatedAt - ISO8601DateTime
|
|
releaseVersion - String
|
Example
{
"releaseCreatedAt": ISO8601DateTime,
"releaseVersion": "xyz789"
}
DocumentFile
DocumentUrl
Fields
| Field Name | Description |
|---|---|
link - String!
|
Example
{"link": "xyz789"}
Education
Description
An educational institution attended by a person
Fields
| Field Name | Description |
|---|---|
endDate - ISO8601DateTime
|
End date of the education |
id - ID!
|
Unique identifier for the education record |
institution - String
|
Name of the educational institution |
person - Person!
|
The person associated with this education record |
startDate - ISO8601DateTime
|
Start date of the education |
value - String
|
Degree or qualification obtained |
Example
{
"endDate": ISO8601DateTime,
"id": "4",
"institution": "xyz789",
"person": Person,
"startDate": ISO8601DateTime,
"value": "xyz789"
}
EmailEntryInput
EmbedUrl
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
|
title - String!
|
|
updatedAt - ISO8601DateTime!
|
|
url - String!
|
Example
{
"createdAt": ISO8601DateTime,
"id": "4",
"title": "xyz789",
"updatedAt": ISO8601DateTime,
"url": "xyz789"
}
Employee
Fields
| Field Name | Description |
|---|---|
contact - Contact!
|
|
department - Department
|
|
email - String!
|
|
hidden - Boolean!
|
|
id - ID!
|
|
info - ContactInfo!
|
|
office - Office
|
Example
{
"contact": Contact,
"department": Department,
"email": "xyz789",
"hidden": true,
"id": 4,
"info": ContactInfo,
"office": Office
}
EmployeeForCustomField
Fields
| Field Name | Description |
|---|---|
email - String!
|
|
id - ID!
|
|
info - ContactInfoForCustomField!
|
Example
{
"email": "xyz789",
"id": "4",
"info": ContactInfoForCustomField
}
EmployeeGrid
Example
{
"departmentName": "abc123",
"email": "xyz789",
"firstName": "xyz789",
"id": 4,
"imageUrl": "xyz789",
"jobTitle": "xyz789",
"lastName": "abc123",
"officeName": "abc123"
}
EmployeeList
Fields
| Field Name | Description |
|---|---|
entries - [Employee!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [Employee],
"pageInfo": PagingInfo
}
EmployeeMeeting
Fields
| Field Name | Description |
|---|---|
companies - [Company!]!
|
|
contacts - [Contact!]!
|
|
endTime - ISO8601DateTime!
|
|
id - ID!
|
|
isCancelled - Boolean!
|
|
keyActivity - KeyActivity
|
|
meetingOrganizer - Contact
|
|
relevantMeetings - [UpcomingMeeting!]!
|
|
sourceEventReference - String!
|
|
startTime - ISO8601DateTime!
|
|
title - String!
|
Example
{
"companies": [Company],
"contacts": [Contact],
"endTime": ISO8601DateTime,
"id": 4,
"isCancelled": false,
"keyActivity": KeyActivity,
"meetingOrganizer": Contact,
"relevantMeetings": [UpcomingMeeting],
"sourceEventReference": "abc123",
"startTime": ISO8601DateTime,
"title": "abc123"
}
EmployeeMeetingsOrderBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"START_TIME_ASC"
ExecutionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AWAITING_START"
ExportAudit
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
dataType - String!
|
Can be one of contact, company, key_activity, generic, opportunities, sent_referrals |
id - ID!
|
|
performer - User
|
The user who performed the export |
primaryName - String!
|
The primary location eg: 'Project name ' or 'Company name' |
rowCount - Int!
|
Number of rows exported |
secondaryName - String!
|
The name of the tab or list |
user - User!
|
The user whose data is being exported |
Example
{
"createdAt": ISO8601DateTime,
"dataType": "abc123",
"id": "4",
"performer": User,
"primaryName": "xyz789",
"rowCount": 987,
"secondaryName": "abc123",
"user": User
}
ExportAuditEntries
Fields
| Field Name | Description |
|---|---|
entries - [ExportAudit!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [ExportAudit],
"pageInfo": PagingInfo
}
ExternalIdentifier
ExternalIdentifierInput
FieldConditionInput
Fields
| Input Field | Description |
|---|---|
on - String!
|
|
operation - ColumnFilterOperationEnum!
|
|
values - [String!]!
|
Example
{
"on": "xyz789",
"operation": "BLANK",
"values": ["xyz789"]
}
File
FilterOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONTAINS"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
Folder
GenericList
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
customFieldSchemas - [CustomFieldSchema!]!
|
|
discardedAt - ISO8601DateTime
|
|
id - ID!
|
|
items - [GenericListItem!]!
|
|
reminderSettings - [ReminderSetting!]!
|
|
title - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"createdAt": ISO8601DateTime,
"customFieldSchemas": [CustomFieldSchema],
"discardedAt": ISO8601DateTime,
"id": "4",
"items": [GenericListItem],
"reminderSettings": [ReminderSetting],
"title": "xyz789",
"updatedAt": ISO8601DateTime
}
GenericListItem
Fields
| Field Name | Description |
|---|---|
completedTasksCount - Int!
|
|
createdAt - ISO8601DateTime!
|
|
customFields - [CustomField!]!
|
Use gridCustomFields instead |
genericList - GenericList!
|
|
gridCustomFields - [CustomFieldGrid!]!
|
|
id - ID!
|
|
listReminders - [Reminder!]!
|
|
tasksCount - Int!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"completedTasksCount": 987,
"createdAt": ISO8601DateTime,
"customFields": [CustomField],
"genericList": GenericList,
"gridCustomFields": [CustomFieldGrid],
"id": 4,
"listReminders": [Reminder],
"tasksCount": 123,
"updatedAt": ISO8601DateTime
}
GenericListItemEntries
Fields
| Field Name | Description |
|---|---|
entries - [GenericListItem!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [GenericListItem],
"pageInfo": PagingInfo
}
GoalDocument
Description
Document objects on goal
Types
| Union Types |
|---|
Example
DocumentFile
GoalOutcome
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LOST"
GridStringArrayScalar
Description
Transfer sql array of strings to graphql array of strings
Example
GridStringArrayScalar
GroupFilter
Fields
| Input Field | Description |
|---|---|
booleanFilters - [BooleanContactSearchFilter!]
|
|
customFieldSelectFilters - [CustomFieldSelectSearchFilter!]
|
|
customFieldTextFilters - [CustomFieldTextSearchFilter!]
|
|
dateFilters - [DateContactSearchFilter!]
|
|
operator - GroupFilterOperator!
|
|
selectFilters - [SelectContactSearchFilter!]
|
|
textFilters - [TextContactSearchFilter!]
|
Example
{
"booleanFilters": [BooleanContactSearchFilter],
"customFieldSelectFilters": [
CustomFieldSelectSearchFilter
],
"customFieldTextFilters": [CustomFieldTextSearchFilter],
"dateFilters": [DateContactSearchFilter],
"operator": "AND",
"selectFilters": [SelectContactSearchFilter],
"textFilters": [TextContactSearchFilter]
}
GroupFilterOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
GroupedObjective
Description
Grouped objectives
Fields
| Field Name | Description |
|---|---|
group - String!
|
|
objectives - [Objective!]!
|
Example
{
"group": "xyz789",
"objectives": [Objective]
}
HideEmployeeMutationPayload
Description
Autogenerated return type of HideEmployeeMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
Hierarchy
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
4
ISO8601Date
Description
An ISO 8601-encoded date
Example
ISO8601Date
ISO8601DateTime
Description
An ISO 8601-encoded datetime
Example
ISO8601DateTime
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
InteractionDetailList
Fields
| Field Name | Description |
|---|---|
entries - [KeyActivity!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [KeyActivity],
"pageInfo": PagingInfo
}
InteractionDetailsFilter
Fields
| Input Field | Description |
|---|---|
categories - [KeyActivityCategory!]
|
|
category - KeyActivityCategory
|
|
companyUid - ID
|
company id or company domain |
contactUid - ID
|
contact id or contact email |
occurredAfter - ISO8601DateTime
|
|
occurredBefore - ISO8601DateTime
|
|
term - String
|
Example
{
"categories": ["BUSINESS_DEVELOPMENT"],
"category": "BUSINESS_DEVELOPMENT",
"companyUid": 4,
"contactUid": 4,
"occurredAfter": ISO8601DateTime,
"occurredBefore": ISO8601DateTime,
"term": "abc123"
}
InteractionDetailsOrderBy
Fields
| Input Field | Description |
|---|---|
direction - InteractionDetailsOrderByDirection
|
|
field - InteractionDetailsOrderByField!
|
Example
{"direction": "ASC", "field": "CREATED_AT"}
InteractionDetailsOrderByDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
InteractionDetailsOrderByField
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
InteractionMaximum
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
lastAt - ISO8601DateTime
|
|
total - Int
|
Example
{
"id": "4",
"lastAt": ISO8601DateTime,
"total": 123
}
InternalIndustry
JSON
Description
Represents untyped JSON
Example
{}
KeyActivity
Fields
| Field Name | Description |
|---|---|
activityTitle - String!
|
|
calendarMeeting - EmployeeMeeting
|
|
category - KeyActivityCategory!
|
|
contactsInvolved - [Contact!]!
|
|
description - String
|
|
id - ID!
|
|
interaction - PartitionedInteraction
|
|
interactionEndAt - ISO8601DateTime
|
|
interactionOn - ISO8601DateTime!
|
|
involvedCompanies - [Company!]!
|
|
involvedContacts - [Contact!]!
|
|
keyActivityListMember - KeyActivityListMember
|
|
notes - RichContent
|
|
sourceReferenceId - String!
|
|
staffInvolved - [Employee!]!
|
Example
{
"activityTitle": "xyz789",
"calendarMeeting": EmployeeMeeting,
"category": "BUSINESS_DEVELOPMENT",
"contactsInvolved": [Contact],
"description": "xyz789",
"id": 4,
"interaction": PartitionedInteraction,
"interactionEndAt": ISO8601DateTime,
"interactionOn": ISO8601DateTime,
"involvedCompanies": [Company],
"involvedContacts": [Contact],
"keyActivityListMember": KeyActivityListMember,
"notes": RichContent,
"sourceReferenceId": "abc123",
"staffInvolved": [Employee]
}
KeyActivityBatchItemInput
Description
Attributes for creating a key activity in batches
Fields
| Input Field | Description |
|---|---|
activityTitle - String!
|
|
description - String
|
|
externalContacts - [String!]!
|
|
interactionEndAt - ISO8601DateTime
|
|
interactionOn - ISO8601DateTime!
|
|
internalContacts - [String!]
|
|
keyActivityCategory - KeyActivityCategory!
|
|
keyActivityListUid - String
|
|
notes - String
|
|
sourceReferenceId - String
|
Example
{
"activityTitle": "abc123",
"description": "abc123",
"externalContacts": ["xyz789"],
"interactionEndAt": ISO8601DateTime,
"interactionOn": ISO8601DateTime,
"internalContacts": ["abc123"],
"keyActivityCategory": "BUSINESS_DEVELOPMENT",
"keyActivityListUid": "abc123",
"notes": "xyz789",
"sourceReferenceId": "xyz789"
}
KeyActivityCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BUSINESS_DEVELOPMENT"
KeyActivityList
Fields
| Field Name | Description |
|---|---|
createdAt - ISO8601DateTime!
|
|
discardedAt - ISO8601DateTime
|
|
id - ID!
|
|
includesKeyActivity - Boolean!
|
|
Arguments
|
|
memberCustomFields - [CustomFieldSchema!]
|
|
name - String!
|
|
project - Project
|
|
updatedAt - ISO8601DateTime!
|
|
Example
{
"createdAt": ISO8601DateTime,
"discardedAt": ISO8601DateTime,
"id": "4",
"includesKeyActivity": true,
"memberCustomFields": [CustomFieldSchema],
"name": "xyz789",
"project": Project,
"updatedAt": ISO8601DateTime
}
KeyActivityListMember
Fields
| Field Name | Description |
|---|---|
customFields - [CustomField!]!
|
|
id - ID!
|
|
isPersisted - Boolean!
|
|
keyActivity - KeyActivity!
|
|
list - KeyActivityList!
|
Example
{
"customFields": [CustomField],
"id": "4",
"isPersisted": false,
"keyActivity": KeyActivity,
"list": KeyActivityList
}
LastAts
Fields
| Field Name | Description |
|---|---|
emailAt - ISO8601DateTime
|
|
id - ID!
|
|
interactionAt - ISO8601DateTime
|
|
meetingAt - ISO8601DateTime
|
|
receivedEmailAt - ISO8601DateTime
|
|
sentEmailAt - ISO8601DateTime
|
Example
{
"emailAt": ISO8601DateTime,
"id": 4,
"interactionAt": ISO8601DateTime,
"meetingAt": ISO8601DateTime,
"receivedEmailAt": ISO8601DateTime,
"sentEmailAt": ISO8601DateTime
}
LinkProjectsToOpportunityMutationPayload
Description
Autogenerated return type of LinkProjectsToOpportunityMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
List
Fields
| Field Name | Description |
|---|---|
allowDuplicates - Boolean!
|
|
category - ListCategory
|
|
clean - Clean
|
|
contactsCount - Int!
|
|
createdAt - ISO8601DateTime!
|
|
creator - User
|
|
discardedAt - ISO8601DateTime
|
|
filterCriteria - JSON
|
|
id - ID!
|
|
listType - ListType!
|
|
memberCustomFields - [CustomFieldSchema!]
|
|
name - String!
|
|
reminderSettings - [ReminderSetting!]!
|
|
renderMode - RenderMode!
|
|
searchTerm - String
|
|
tabUid - ID
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"allowDuplicates": false,
"category": "CLIENT_ALERT",
"clean": Clean,
"contactsCount": 123,
"createdAt": ISO8601DateTime,
"creator": User,
"discardedAt": ISO8601DateTime,
"filterCriteria": {},
"id": 4,
"listType": "DYNAMIC",
"memberCustomFields": [CustomFieldSchema],
"name": "xyz789",
"reminderSettings": [ReminderSetting],
"renderMode": "CLIENT_SIDE",
"searchTerm": "xyz789",
"tabUid": "4",
"updatedAt": ISO8601DateTime
}
ListCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CLIENT_ALERT"
ListEntries
Fields
| Field Name | Description |
|---|---|
entries - [List!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [List],
"pageInfo": PagingInfo
}
ListFiltering
Description
Options for filtering lists
Fields
| Input Field | Description |
|---|---|
category - ListCategory
|
|
listStatus - ListStatus
|
|
listType - ListType
|
|
projectUuid - ID
|
|
term - String
|
|
usageModes - [UsageModeFilter!]
|
Example
{
"category": "CLIENT_ALERT",
"listStatus": "ACTIVE",
"listType": "DYNAMIC",
"projectUuid": 4,
"term": "abc123",
"usageModes": ["MARKETING"]
}
ListMember
Fields
| Field Name | Description |
|---|---|
completedTasksCount - Int!
|
|
contact - Contact!
|
|
createdAt - ISO8601DateTime!
|
|
creator - User
|
|
customFields - [CustomField!]!
|
|
discardedAt - ISO8601DateTime
|
|
id - ID!
|
|
listId - ID!
|
|
listReminders - [Reminder!]!
|
|
myContact - MyContact
|
|
remover - User
|
|
tasksCount - Int!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"completedTasksCount": 123,
"contact": Contact,
"createdAt": ISO8601DateTime,
"creator": User,
"customFields": [CustomField],
"discardedAt": ISO8601DateTime,
"id": 4,
"listId": 4,
"listReminders": [Reminder],
"myContact": MyContact,
"remover": User,
"tasksCount": 987,
"updatedAt": ISO8601DateTime
}
ListMembers
Fields
| Field Name | Description |
|---|---|
entries - [ListMember!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [ListMember],
"pageInfo": PagingInfo
}
ListMembersFilter
Description
Filtering Options for filtering list members
Fields
| Input Field | Description |
|---|---|
addedBy - [ID!]
|
Employee ID. Default = [] |
communicationCondition - ContactCommunicationCondition
|
|
consentStatus - [ContactConsentStatus!]
|
|
contactUids - [ID!]
|
filter members by contact id or email |
contactUidsNoDuplicates - [ID!]
|
filter members by contact uids ignoring duplicate lists |
excludeClassified - Boolean
|
|
excludeHidden - Boolean
|
|
ids - [ID!]
|
List Member ids |
marketingListOnly - Boolean
|
|
myContacts - Boolean
|
|
scope - ListMembersScope
|
|
tags - [String!]
|
Example
{
"addedBy": ["4"],
"communicationCondition": "ANY",
"consentStatus": ["CONSENT_GIVEN"],
"contactUids": ["4"],
"contactUidsNoDuplicates": [4],
"excludeClassified": true,
"excludeHidden": true,
"ids": [4],
"marketingListOnly": true,
"myContacts": true,
"scope": "KEPT",
"tags": ["xyz789"]
}
ListMembersOrderBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADDED_BY_ASC"
ListMembersScope
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"KEPT"
ListStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
ListType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DYNAMIC"
ListsOrderBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREATED_AT_ASC"
Location
LocationAttributes
MarkKeyActivityMutationPayload
Description
Autogenerated return type of MarkKeyActivityMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
keyActitivityListMember - KeyActivityListMember
|
|
keyActivity - KeyActivity
|
Example
{
"failReasons": ["xyz789"],
"keyActitivityListMember": KeyActivityListMember,
"keyActivity": KeyActivity
}
MarketingListFiltering
Description
Options for filtering lists
Fields
| Input Field | Description |
|---|---|
category - ListCategory
|
|
listType - ListType
|
|
term - String
|
Example
{
"category": "CLIENT_ALERT",
"listType": "DYNAMIC",
"term": "abc123"
}
MarketingListSyncRequest
Fields
| Field Name | Description |
|---|---|
connectedList - ConnectedList
|
|
createdAt - ISO8601DateTime!
|
|
id - ID!
|
Example
{
"connectedList": ConnectedList,
"createdAt": ISO8601DateTime,
"id": 4
}
MeetingList
Fields
| Field Name | Description |
|---|---|
entries - [EmployeeMeeting!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [EmployeeMeeting],
"pageInfo": PagingInfo
}
MeetingsFiltering
Description
Filtering Options for meetings
Fields
| Input Field | Description |
|---|---|
companyUid - ID
|
Company ID or Company Domain |
contactUid - ID
|
Contact ID or Contact Email |
keyActivityCategories - [KeyActivityCategory!]
|
|
startTimeAfter - ISO8601DateTime
|
|
startTimeBefore - ISO8601DateTime
|
Example
{
"companyUid": 4,
"contactUid": 4,
"keyActivityCategories": ["BUSINESS_DEVELOPMENT"],
"startTimeAfter": ISO8601DateTime,
"startTimeBefore": ISO8601DateTime
}
MeetingsOwnership
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ALL"
MeetingsTimeScope
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
Money
MyContact
Fields
| Field Name | Description |
|---|---|
archived - Boolean!
|
|
classified - Boolean!
|
|
contact - Contact!
|
|
createdAt - ISO8601DateTime
|
|
id - ID!
|
|
interactionMaximum - InteractionMaximum
|
|
stayInTouch - MyStayInTouch
|
Example
{
"archived": true,
"classified": true,
"contact": Contact,
"createdAt": ISO8601DateTime,
"id": "4",
"interactionMaximum": InteractionMaximum,
"stayInTouch": MyStayInTouch
}
MyStayInTouch
Fields
| Field Name | Description |
|---|---|
contact - MyContact!
|
|
frequency - StayInTouchFrequency!
|
|
id - ID!
|
|
interactionDueDate - ISO8601Date!
|
|
overDue - Boolean!
|
Example
{
"contact": MyContact,
"frequency": "BIWEEKLY",
"id": 4,
"interactionDueDate": ISO8601Date,
"overDue": false
}
MyTask
Fields
| Field Name | Description |
|---|---|
assignees - [Employee!]!
|
|
completedAt - ISO8601DateTime
|
|
createdAt - ISO8601DateTime!
|
|
description - RichContent
|
|
dueOn - ISO8601Date
|
|
id - ID!
|
|
requestor - Employee
|
|
source - MyTaskSource!
|
|
title - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"assignees": [Employee],
"completedAt": ISO8601DateTime,
"createdAt": ISO8601DateTime,
"description": RichContent,
"dueOn": ISO8601Date,
"id": 4,
"requestor": Employee,
"source": MyTaskSource,
"title": "xyz789",
"updatedAt": ISO8601DateTime
}
MyTaskSource
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
imgUrl - String
|
|
isKeyContact - Boolean!
|
|
subTitle - ContactEmailScalar!
|
|
title - ContactEmailScalar!
|
|
url - Url
|
Example
{
"id": 4,
"imgUrl": "xyz789",
"isKeyContact": false,
"subTitle": ContactEmailScalar,
"title": ContactEmailScalar,
"url": Url
}
Objective
Fields
| Field Name | Description |
|---|---|
appendValueType - Boolean!
|
|
archive - Boolean!
|
|
createdAt - ISO8601DateTime!
|
|
createdBy - User!
|
|
currentProgress - Progress!
|
|
description - RichContent
|
|
id - ID!
|
|
initialValue - Int
|
|
objectiveProgresses - [Progress!]!
|
|
owners - [Employee!]!
|
|
projects - [Project!]!
|
|
targetDate - ISO8601Date!
|
|
targetValue - Int!
|
|
title - String!
|
|
valueType - String!
|
Example
{
"appendValueType": false,
"archive": true,
"createdAt": ISO8601DateTime,
"createdBy": User,
"currentProgress": Progress,
"description": RichContent,
"id": 4,
"initialValue": 123,
"objectiveProgresses": [Progress],
"owners": [Employee],
"projects": [Project],
"targetDate": ISO8601Date,
"targetValue": 123,
"title": "xyz789",
"valueType": "xyz789"
}
ObjectiveGroupBy
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DEPARTMENT"
ObjectiveStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
Office
Fields
| Field Name | Description |
|---|---|
employees - [Employee!]!
|
|
Arguments
|
|
id - ID!
|
|
name - String!
|
|
Example
{
"employees": [Employee],
"id": "4",
"name": "abc123"
}
Opportunity
Description
Opportunity information
Fields
| Field Name | Description |
|---|---|
archived - Boolean!
|
|
assignedTo - Employee
|
|
company - Company!
|
|
contactLast - LastAts
|
|
createdAt - ISO8601DateTime!
|
|
createdBy - User
|
|
customFields - [CustomField!]!
|
|
customStatus - OpportunityTrackingCustomStatus
|
|
date - ISO8601Date
|
|
description - RichContent
|
|
documents - [GoalDocument!]!
|
|
emailBody - RichContent
|
|
id - ID!
|
|
includedLawyers - [Employee!]!
|
|
keyContacts - [Contact!]
|
|
outcome - GoalOutcome!
|
|
project - Project
|
|
proposedFee - Float
|
|
proposedFeeAmount - Money
|
|
receivedReferral - Boolean!
|
|
referralSource - Contact
|
|
tags - [String!]!
|
|
title - String
|
|
trackingNumber - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"archived": false,
"assignedTo": Employee,
"company": Company,
"contactLast": LastAts,
"createdAt": ISO8601DateTime,
"createdBy": User,
"customFields": [CustomField],
"customStatus": OpportunityTrackingCustomStatus,
"date": ISO8601Date,
"description": RichContent,
"documents": [DocumentFile],
"emailBody": RichContent,
"id": 4,
"includedLawyers": [Employee],
"keyContacts": [Contact],
"outcome": "LOST",
"project": Project,
"proposedFee": 123.45,
"proposedFeeAmount": Money,
"receivedReferral": false,
"referralSource": Contact,
"tags": ["abc123"],
"title": "xyz789",
"trackingNumber": "abc123",
"updatedAt": ISO8601DateTime
}
OpportunityGrid
Fields
| Field Name | Description |
|---|---|
assignedTo - EmployeeGrid
|
|
commsLast - LastAts
|
|
company - CompanyGrid!
|
|
createdAt - ISO8601DateTime!
|
|
createdBy - UserGrid
|
|
customFields - [CustomFieldGrid!]!
|
|
customStatus - OpportunityTrackingCustomStatus
|
|
date - ISO8601Date!
|
|
id - ID!
|
|
keyContacts - [ContactGrid!]!
|
|
othersIncluded - [EmployeeGrid!]!
|
|
proposedFeeAmount - Money
|
|
referralSource - ContactGrid
|
|
tags - [String!]!
|
|
title - String
|
|
trackingNumber - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"assignedTo": EmployeeGrid,
"commsLast": LastAts,
"company": CompanyGrid,
"createdAt": ISO8601DateTime,
"createdBy": UserGrid,
"customFields": [CustomFieldGrid],
"customStatus": OpportunityTrackingCustomStatus,
"date": ISO8601Date,
"id": 4,
"keyContacts": [ContactGrid],
"othersIncluded": [EmployeeGrid],
"proposedFeeAmount": Money,
"referralSource": ContactGrid,
"tags": ["abc123"],
"title": "xyz789",
"trackingNumber": "xyz789",
"updatedAt": ISO8601DateTime
}
OpportunityGridTypeList
Fields
| Field Name | Description |
|---|---|
entries - [OpportunityGrid!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [OpportunityGrid],
"pageInfo": PagingInfo
}
OpportunityStatusChange
Description
Opportunity status change information
Fields
| Field Name | Description |
|---|---|
createdAt - ID!
|
|
fromStatus - OpportunityTrackingCustomStatus
|
|
id - ID!
|
|
opportunity - Opportunity!
|
|
toStatus - OpportunityTrackingCustomStatus
|
Example
{
"createdAt": 4,
"fromStatus": OpportunityTrackingCustomStatus,
"id": 4,
"opportunity": Opportunity,
"toStatus": OpportunityTrackingCustomStatus
}
OpportunityTimeFilter
Description
Options for filtering by time
Fields
| Input Field | Description |
|---|---|
position - TimeFilterPosition!
|
|
property - OpportunityTimeFilterProperty!
|
|
value - ISO8601DateTime!
|
Example
{
"position": "AFTER",
"property": "CREATED",
"value": ISO8601DateTime
}
OpportunityTimeFilterProperty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREATED"
OpportunityTrackingArchiveGoalMutationPayload
Description
Autogenerated return type of OpportunityTrackingArchiveGoalMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
OpportunityTrackingCreateOpportunityMutationPayload
Description
Autogenerated return type of OpportunityTrackingCreateOpportunityMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
gridRecord - OpportunityGrid
|
|
record - CompanyGoal
|
|
uid - ID
|
Example
{
"failReasons": ["abc123"],
"gridRecord": OpportunityGrid,
"record": CompanyGoal,
"uid": "4"
}
OpportunityTrackingCustomStatus
OpportunityTrackingUpdateOpportunityMutationPayload
Description
Autogenerated return type of OpportunityTrackingUpdateOpportunityMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
gridRecord - OpportunityGrid!
|
|
record - CompanyGoal!
|
Example
{
"failReasons": ["abc123"],
"gridRecord": OpportunityGrid,
"record": CompanyGoal
}
Option
Fields
| Field Name | Description |
|---|---|
colour - AccountColour!
|
|
id - ID!
|
|
value - String!
|
Example
{
"colour": "COL1",
"id": "4",
"value": "abc123"
}
OptionChoice
Fields
| Field Name | Description |
|---|---|
colour - AccountColour!
|
|
createdAt - ISO8601DateTime!
|
|
creator - UserInfo
|
|
id - String!
|
|
optionChoiceId - String!
|
|
orderRank - Int!
|
|
preferenceMarketingList - List
|
|
updatedAt - ISO8601DateTime!
|
|
value - String!
|
Example
{
"colour": "COL1",
"createdAt": ISO8601DateTime,
"creator": UserInfo,
"id": "xyz789",
"optionChoiceId": "xyz789",
"orderRank": 987,
"preferenceMarketingList": List,
"updatedAt": ISO8601DateTime,
"value": "abc123"
}
OptionsAttributes
Fields
| Input Field | Description |
|---|---|
colour - AccountColour
|
|
title - String!
|
Example
{"colour": "COL1", "title": "abc123"}
OwnedByInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
type - OwnedByType!
|
Example
{"id": "4", "type": "COMPANY"}
OwnedByType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANY"
PageResult
Description
Company list, contact list, or saved view fields value
Example
BlockPageList
PagingInfo
PartitionedInteraction
Fields
| Field Name | Description |
|---|---|
companies - [Company!]!
|
|
contacts - [Contact!]!
|
|
direction - PartitionedInteractionDirection!
|
|
id - ID!
|
|
interactionType - PartitionedInteractionType!
|
|
keyActivity - KeyActivity
|
|
occuredAt - ISO8601DateTime
|
|
occuredEndAt - ISO8601DateTime
|
|
occuredEndOn - ISO8601Date
|
|
occuredOn - ISO8601Date
|
|
receivers - [Contact!]!
|
|
sender - Contact
|
|
sourceReferenceId - String!
|
|
webLink - String
|
Example
{
"companies": [Company],
"contacts": [Contact],
"direction": "DIRECTION_PENDING",
"id": "4",
"interactionType": "CUSTOM",
"keyActivity": KeyActivity,
"occuredAt": ISO8601DateTime,
"occuredEndAt": ISO8601DateTime,
"occuredEndOn": ISO8601Date,
"occuredOn": ISO8601Date,
"receivers": [Contact],
"sender": Contact,
"sourceReferenceId": "xyz789",
"webLink": "abc123"
}
PartitionedInteractionDirection
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DIRECTION_PENDING"
PartitionedInteractionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CUSTOM"
Person
Fields
| Field Name | Description |
|---|---|
activeContacts - [Contact!]!
|
|
careerCompanies - [CareerCompany!]!
|
|
contacts - [Contact!]!
|
|
discardedAt - ISO8601DateTime
|
|
educations - [Education!]!
|
|
externalImageUrl - Url
|
|
firstName - String!
|
|
gender - String
|
|
id - ID!
|
|
lastName - String!
|
|
linkedinUrl - Url
|
|
location - Location
|
|
phoneNumbers - [PhoneNumber!]!
|
|
skills - [String!]!
|
|
tags - [String!]!
|
|
twitterUrl - Url
|
Example
{
"activeContacts": [Contact],
"careerCompanies": [CareerCompany],
"contacts": [Contact],
"discardedAt": ISO8601DateTime,
"educations": [Education],
"externalImageUrl": Url,
"firstName": "abc123",
"gender": "abc123",
"id": 4,
"lastName": "abc123",
"linkedinUrl": Url,
"location": Location,
"phoneNumbers": [PhoneNumber],
"skills": ["xyz789"],
"tags": ["xyz789"],
"twitterUrl": Url
}
PhoneNumber
Description
A phone number
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Unique identifier for the phone number |
phoneType - PhoneTypeEnum
|
Type of phone number (e.g., Company Direct, Assistant) |
value - String!
|
The phone number value |
Example
{
"id": "4",
"phoneType": "ASSISTANT",
"value": "xyz789"
}
PhoneNumberAttributes
Fields
| Input Field | Description |
|---|---|
phoneType - PhoneTypeEnum
|
|
value - String!
|
Example
{
"phoneType": "ASSISTANT",
"value": "xyz789"
}
PhoneTypeEnum
Description
Valid phone number types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ASSISTANT"
PipelineAggregates
Description
Pipeline aggregate metrics for an opportunities list
Fields
| Field Name | Description |
|---|---|
byStatus - [StatusAggregate!]!
|
Breakdown by each standard status |
totalCount - Int!
|
Total number of opportunities matching current filters |
totalValue - Money!
|
Total proposed fee for matching opportunities |
Example
{
"byStatus": [StatusAggregate],
"totalCount": 123,
"totalValue": Money
}
PreferenceField
PrepareClientCompaniesForSyncMutationPayload
Description
Autogenerated return type of PrepareClientCompaniesForSyncMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
PriorityEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"critical"
Progress
Fields
| Field Name | Description |
|---|---|
checkinDate - ISO8601Date!
|
|
comment - RichContent
|
|
createdBy - User!
|
|
id - ID!
|
|
measureValue - Int!
|
|
progressStatus - ProgressStatus!
|
Example
{
"checkinDate": ISO8601Date,
"comment": RichContent,
"createdBy": User,
"id": "4",
"measureValue": 987,
"progressStatus": "LAGGING"
}
ProgressStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"LAGGING"
Project
Fields
| Field Name | Description |
|---|---|
colorCode - String
|
|
createdAt - ISO8601DateTime!
|
|
createdBy - Employee
|
|
description - RichContent
|
|
discardedAt - ISO8601DateTime
|
|
documents - [ProjectDocument!]!
|
|
firmWide - Boolean!
|
|
folder - Folder!
|
|
iconCode - String
|
|
id - ID!
|
|
nexlApps - Boolean!
|
|
objectives - [Objective!]!
|
|
opportunityCustomFieldSchemas - [CustomFieldSchema!]!
|
|
overviewTab - ProjectOverviewTab
|
|
readOnly - Boolean!
|
|
tabGroupName - String!
|
|
tabs - [TabResult!]!
|
|
teamMembersCount - Int!
|
|
title - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"colorCode": "abc123",
"createdAt": ISO8601DateTime,
"createdBy": Employee,
"description": RichContent,
"discardedAt": ISO8601DateTime,
"documents": [ProjectDocument],
"firmWide": false,
"folder": Folder,
"iconCode": "abc123",
"id": 4,
"nexlApps": false,
"objectives": [Objective],
"opportunityCustomFieldSchemas": [CustomFieldSchema],
"overviewTab": ProjectOverviewTab,
"readOnly": false,
"tabGroupName": "xyz789",
"tabs": [TabResult],
"teamMembersCount": 123,
"title": "abc123",
"updatedAt": ISO8601DateTime
}
ProjectAttribute
Description
Project attribute
Example
{
"colorCode": "abc123",
"description": "abc123",
"firmWide": false,
"folderId": 4,
"iconCode": "abc123",
"nexlApps": true,
"readOnly": false,
"sourceProjectId": "4",
"title": "abc123"
}
ProjectDocument
ProjectOverviewTab
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Example
{"id": "4"}
ProjectTaskSection
PurgeContactMutationPayload
Description
Autogenerated return type of PurgeContactMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
ReSyncClientCompanyMutationPayload
Description
Autogenerated return type of ReSyncClientCompanyMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
RelationshipPartner
Description
Relationship Partner of a Company
Example
{
"company": Company,
"discardedAt": ISO8601DateTime,
"employee": Employee,
"id": "4",
"interactionsLast": LastAts,
"interactionsTotal": Totals
}
RelationshipPartnerList
Fields
| Field Name | Description |
|---|---|
entries - [RelationshipPartner!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [RelationshipPartner],
"pageInfo": PagingInfo
}
Reminder
Fields
| Field Name | Description |
|---|---|
active - Boolean!
|
|
createdAt - ISO8601DateTime!
|
|
emailSentDate - ISO8601DateTime
|
|
id - ID!
|
|
reminderSetting - ReminderSetting!
|
|
reminderSettingId - ID!
|
Example
{
"active": true,
"createdAt": ISO8601DateTime,
"emailSentDate": ISO8601DateTime,
"id": "4",
"reminderSetting": ReminderSetting,
"reminderSettingId": "4"
}
ReminderSetting
Fields
| Field Name | Description |
|---|---|
dateProperty - String!
|
|
emailSubject - String!
|
|
id - ID!
|
|
owners - [ReminderSettingOwner!]!
|
|
reminderDays - Int!
|
|
timePreposition - ReminderSettingTimePreposition!
|
Example
{
"dateProperty": "xyz789",
"emailSubject": "xyz789",
"id": 4,
"owners": [ReminderSettingOwner],
"reminderDays": 987,
"timePreposition": "AFTER"
}
ReminderSettingOwner
ReminderSettingTimePreposition
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AFTER"
RemoveCompanyRelationshipPartnerMutationPayload
Description
Autogenerated return type of RemoveCompanyRelationshipPartnerMutation.
Fields
| Field Name | Description |
|---|---|
discarded - RelationshipPartner
|
|
failReasons - [String!]!
|
Example
{
"discarded": RelationshipPartner,
"failReasons": ["abc123"]
}
RemoveGenericListItemsMutationPayload
Description
Autogenerated return type of RemoveGenericListItemsMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
RemoveKeyActivityMutationPayload
Description
Autogenerated return type of RemoveKeyActivityMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
RemoveListMutationPayload
Description
Autogenerated return type of RemoveListMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
RemoveOfficeLocationMutationPayload
Description
Autogenerated return type of RemoveOfficeLocationMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
RenderMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CLIENT_SIDE"
ReopenMyTaskMutationPayload
Description
Autogenerated return type of ReopenMyTaskMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
task - MyTask
|
Example
{
"failReasons": ["abc123"],
"task": MyTask
}
ReportedIncorrectCompanyInfo
Fields
| Field Name | Description |
|---|---|
comment - String
|
|
company - Company!
|
|
fields - [String!]!
|
|
id - ID!
|
|
reporter - User!
|
Example
{
"comment": "abc123",
"company": Company,
"fields": ["abc123"],
"id": 4,
"reporter": User
}
ReportedIncorrectCompanyInfoEntries
Fields
| Field Name | Description |
|---|---|
entries - [ReportedIncorrectCompanyInfo!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [ReportedIncorrectCompanyInfo],
"pageInfo": PagingInfo
}
ReportedIncorrectInfo
Fields
| Field Name | Description |
|---|---|
comment - String
|
|
contact - Contact!
|
|
fields - [String!]!
|
|
id - ID!
|
|
reporter - UserInfo!
|
Example
{
"comment": "xyz789",
"contact": Contact,
"fields": ["xyz789"],
"id": "4",
"reporter": UserInfo
}
ReportedIncorrectInfoEntries
Fields
| Field Name | Description |
|---|---|
entries - [ReportedIncorrectInfo!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [ReportedIncorrectInfo],
"pageInfo": PagingInfo
}
ReportedIncorrectInfosFiltering
Fields
| Input Field | Description |
|---|---|
createdAfter - ISO8601DateTime
|
Example
{"createdAfter": ISO8601DateTime}
RichContent
RoleCode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADMIN"
RowTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADMIN_TEMPLATES"
SaveView
ScheduleCampaignMutationPayload
Description
Autogenerated return type of ScheduleCampaignMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
scheduledCampaign - Campaign
|
Example
{
"failReasons": ["xyz789"],
"scheduledCampaign": Campaign
}
SelectContactSearchFilter
Fields
| Input Field | Description |
|---|---|
operator - SelectSearchOperator!
|
|
property - SelectContactSearchableProperty!
|
|
values - [String!]!
|
Example
{
"operator": "IS",
"property": "COMPANY_HIERARCHY",
"values": ["xyz789"]
}
SelectContactSearchableProperty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"COMPANY_HIERARCHY"
SelectSearchOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"IS"
Sender
SentReferral
Fields
| Field Name | Description |
|---|---|
clientCompany - Company
|
|
clientContact - Contact
|
|
createdAt - ISO8601DateTime!
|
|
customFields - [CustomField!]!
|
|
discardedAt - ISO8601DateTime
|
|
externalIdentifier - String
|
|
id - ID!
|
|
referredByEmployee - Employee!
|
|
resultStatus - SentReferralResultStatus!
|
|
sentAt - ISO8601DateTime!
|
|
sentToContact - Contact!
|
|
typeOfLegalMatter - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"clientCompany": Company,
"clientContact": Contact,
"createdAt": ISO8601DateTime,
"customFields": [CustomField],
"discardedAt": ISO8601DateTime,
"externalIdentifier": "xyz789",
"id": 4,
"referredByEmployee": Employee,
"resultStatus": "SENT",
"sentAt": ISO8601DateTime,
"sentToContact": Contact,
"typeOfLegalMatter": "abc123",
"updatedAt": ISO8601DateTime
}
SentReferralEntries
Fields
| Field Name | Description |
|---|---|
entries - [SentReferral!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [SentReferral],
"pageInfo": PagingInfo
}
SentReferralResultStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SENT"
SentReferralTimeFilter
Description
Options for filtering by time
Fields
| Input Field | Description |
|---|---|
position - TimeFilterPosition!
|
|
property - SentReferralTimeFilterProperty!
|
|
value - ISO8601DateTime!
|
Example
{
"position": "AFTER",
"property": "CREATED",
"value": ISO8601DateTime
}
SentReferralTimeFilterProperty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"CREATED"
SentReferralsFilterInput
Fields
| Input Field | Description |
|---|---|
externalIdentifier - String
|
|
term - String
|
|
timeFilters - [SentReferralTimeFilter!]
|
Example
{
"externalIdentifier": "xyz789",
"term": "abc123",
"timeFilters": [SentReferralTimeFilter]
}
SetUserRoleMutationPayload
Description
Autogenerated return type of SetUserRoleMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
user - User
|
Example
{
"failReasons": ["abc123"],
"user": User
}
ShowEmployeeMutationPayload
Description
Autogenerated return type of ShowEmployeeMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
StatusAggregate
Description
Aggregate metrics for a single opportunity status
Example
{
"count": 987,
"status": "xyz789",
"sum": Money
}
StayInTouchFrequency
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BIWEEKLY"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
SyncOutlookContactForUserMutationPayload
Description
Autogenerated return type of SyncOutlookContactForUserMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
TabRenderMode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ADVANCED"
TabResult
Description
Tab Field Value
Fields
| Field Name | Description |
|---|---|
discardedAt - ISO8601DateTime
|
|
id - String!
|
|
isAppTab - Boolean!
|
|
isWorkspaceTab - Boolean!
|
|
name - String!
|
|
pageResult - PageResult!
|
|
position - Int!
|
|
renderMode - TabRenderMode!
|
Example
{
"discardedAt": ISO8601DateTime,
"id": "xyz789",
"isAppTab": true,
"isWorkspaceTab": true,
"name": "xyz789",
"pageResult": BlockPageList,
"position": 123,
"renderMode": "ADVANCED"
}
TableLikeSourceInput
Example
{
"companyUid": 4,
"listUid": "4",
"listViewUid": "4",
"projectUid": "4",
"rowType": "ADMIN_TEMPLATES",
"sourceScopes": ["xyz789"]
}
Task
Fields
| Field Name | Description |
|---|---|
assignedTo - Employee
|
|
company - Company
|
|
companyListMember - CompanyListMember
|
|
completedAt - ISO8601DateTime
|
|
completer - UserInfo
|
|
contact - Contact
|
|
contactListMember - ContactListGridMember
|
|
createdAt - ISO8601DateTime!
|
|
createdBy - Employee!
|
|
description - RichContent
|
|
dueOn - ISO8601Date
|
|
genericListMember - GenericListItem
|
|
id - ID!
|
|
position - Int
|
|
priority - PriorityEnum
|
|
project - Project
|
|
projectTaskSection - ProjectTaskSection
|
|
requestedBy - Employee
|
|
title - String!
|
|
updatedAt - ISO8601DateTime!
|
Example
{
"assignedTo": Employee,
"company": Company,
"companyListMember": CompanyListMember,
"completedAt": ISO8601DateTime,
"completer": UserInfo,
"contact": Contact,
"contactListMember": ContactListGridMember,
"createdAt": ISO8601DateTime,
"createdBy": Employee,
"description": RichContent,
"dueOn": ISO8601Date,
"genericListMember": GenericListItem,
"id": 4,
"position": 123,
"priority": "critical",
"project": Project,
"projectTaskSection": ProjectTaskSection,
"requestedBy": Employee,
"title": "xyz789",
"updatedAt": ISO8601DateTime
}
Template
TemplateCompanyDisplayModeEnum
Description
Display mode for a custom object template on the company slider/page
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SECTION"
TemplateContactSliderDisplayModeEnum
Description
Display mode for a custom object template on the contact slider
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SECTION"
TemplateEmployeeDisplayModeEnum
Description
Display mode for a custom object template on the contact slider for employee contacts
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"SECTION"
TemplateFieldAssociationTypeEnum
Description
An available association type for template fields
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPANY"
TemplateFieldType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ANOTHER_DATA_RECORD"
TextContactSearchFilter
Fields
| Input Field | Description |
|---|---|
operator - TextSearchOperator!
|
|
property - TextContactSearchableProperty!
|
|
values - [String!]
|
Example
{
"operator": "CONTAINS",
"property": "CITY",
"values": ["abc123"]
}
TextContactSearchableProperty
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CITY"
TextSearchOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CONTAINS"
TimeFilterPosition
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AFTER"
TimeRange
Description
Time Range information
Fields
| Field Name | Description |
|---|---|
endTime - ISO8601DateTime!
|
|
startTime - ISO8601DateTime!
|
Example
{
"endTime": ISO8601DateTime,
"startTime": ISO8601DateTime
}
Totals
TrackBouncedEmailMutationPayload
Description
Autogenerated return type of TrackBouncedEmailMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
UnblockDomainMutationPayload
Description
Autogenerated return type of UnblockDomainMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
UnblockEmailMutationPayload
Description
Autogenerated return type of UnblockEmailMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
UpcomingMeeting
Fields
| Field Name | Description |
|---|---|
companies - [Company!]!
|
|
contacts - [Contact!]!
|
|
endTime - ISO8601DateTime!
|
|
id - ID!
|
|
isCancelled - Boolean!
|
|
keyActivity - KeyActivity
|
|
meetingOrganizer - Contact
|
|
relevantMeetings - [UpcomingMeeting!]!
|
|
sourceEventReference - String!
|
|
startTime - ISO8601DateTime!
|
Example
{
"companies": [Company],
"contacts": [Contact],
"endTime": ISO8601DateTime,
"id": 4,
"isCancelled": true,
"keyActivity": KeyActivity,
"meetingOrganizer": Contact,
"relevantMeetings": [UpcomingMeeting],
"sourceEventReference": "abc123",
"startTime": ISO8601DateTime
}
UpdateCampaignMutationPayload
Description
Autogenerated return type of UpdateCampaignMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
updatedCampaign - Campaign
|
Example
{
"failReasons": ["xyz789"],
"updatedCampaign": Campaign
}
UpdateCompanyMutationPayload
Description
Autogenerated return type of UpdateCompanyMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - Company
|
Example
{
"failReasons": ["abc123"],
"record": Company
}
UpdateCompanyNoteMutationPayload
Description
Autogenerated return type of UpdateCompanyNoteMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - CompanyNote
|
Example
{
"failReasons": ["abc123"],
"record": CompanyNote
}
UpdateConnectedListMutationPayload
Description
Autogenerated return type of UpdateConnectedListMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
UpdateContactConsentMutationPayload
Description
Autogenerated return type of UpdateContactConsentMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - ContactConsent
|
Example
{
"failReasons": ["abc123"],
"record": ContactConsent
}
UpdateContactCustomFieldMutationPayload
Description
Autogenerated return type of UpdateContactCustomFieldMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
UpdateContactMutationPayload
Description
Autogenerated return type of UpdateContactMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - Contact
|
Example
{
"failReasons": ["abc123"],
"record": Contact
}
UpdateGenericListItemsMutationPayload
Description
Autogenerated return type of UpdateGenericListItemsMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
records - [GenericListItem!]!
|
Example
{
"failReasons": ["xyz789"],
"records": [GenericListItem]
}
UpdateListMutationPayload
Description
Autogenerated return type of UpdateListMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
list - List!
|
Example
{
"failReasons": ["abc123"],
"list": List
}
UpdateMyTaskMutationPayload
Description
Autogenerated return type of UpdateMyTaskMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
task - MyTask
|
Example
{
"failReasons": ["abc123"],
"task": MyTask
}
UpdateOfficeLocationMutationPayload
Description
Autogenerated return type of UpdateOfficeLocationMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - CompanyOfficeLocation
|
Example
{
"failReasons": ["abc123"],
"record": CompanyOfficeLocation
}
UpdateProjectMutationPayload
Description
Autogenerated return type of UpdateProjectMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["xyz789"]}
UpdateSentReferralMutationPayload
Description
Autogenerated return type of UpdateSentReferralMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
record - SentReferral
|
Example
{
"failReasons": ["abc123"],
"record": SentReferral
}
UpdateSyncListRequestMutationPayload
Description
Autogenerated return type of UpdateSyncListRequestMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
Example
{"failReasons": ["abc123"]}
UpdateTagsOnCompaniesMutationPayload
Description
Autogenerated return type of UpdateTagsOnCompaniesMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
infos - [CompanyInfo!]!
|
Example
{
"failReasons": ["xyz789"],
"infos": [CompanyInfo]
}
UpdateTagsOnContactsMutationPayload
Description
Autogenerated return type of UpdateTagsOnContactsMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
infos - [ContactInfo!]!
|
Example
{
"failReasons": ["xyz789"],
"infos": [ContactInfo]
}
UpdateUserMutationPayload
Description
Autogenerated return type of UpdateUserMutation.
Fields
| Field Name | Description |
|---|---|
failReasons - [String!]!
|
|
user - User
|
Example
{
"failReasons": ["abc123"],
"user": User
}
Url
Description
A valid URL, transported as a string
Example
Url
UsageModeFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MARKETING"
User
Fields
| Field Name | Description |
|---|---|
accessRole - AccessRole
|
|
archivedAt - ISO8601DateTime
|
|
canArchiveContactsAndCompanies - Boolean!
|
|
canUpdateCompanyName - Boolean!
|
|
canViewActivityViewDetail - Boolean!
|
|
canViewEmbeddedReport - Boolean!
|
|
delegateAccess - Boolean!
|
|
email - String!
|
|
employee - Employee
|
|
firstName - String
|
|
id - ID!
|
|
isActive - Boolean!
|
|
isSuperAdmin - Boolean!
|
|
lastLoginAt - ISO8601DateTime
|
|
lastName - String
|
|
profileImageUrl - String
|
|
profileName - String!
|
|
role - RoleCode!
|
|
userId - ID!
|
Example
{
"accessRole": AccessRole,
"archivedAt": ISO8601DateTime,
"canArchiveContactsAndCompanies": false,
"canUpdateCompanyName": false,
"canViewActivityViewDetail": false,
"canViewEmbeddedReport": true,
"delegateAccess": true,
"email": "xyz789",
"employee": Employee,
"firstName": "xyz789",
"id": "4",
"isActive": true,
"isSuperAdmin": false,
"lastLoginAt": ISO8601DateTime,
"lastName": "abc123",
"profileImageUrl": "abc123",
"profileName": "xyz789",
"role": "ADMIN",
"userId": 4
}
UserCard
Fields
| Field Name | Description |
|---|---|
contactId - Int
|
|
discardedAt - ISO8601DateTime
|
|
email - ContactEmailScalar
|
|
firstName - String
|
|
id - ID!
|
|
imageUrl - String
|
|
jobTitle - String
|
|
lastName - String
|
|
userId - ID!
|
Example
{
"contactId": 123,
"discardedAt": ISO8601DateTime,
"email": ContactEmailScalar,
"firstName": "xyz789",
"id": "4",
"imageUrl": "abc123",
"jobTitle": "abc123",
"lastName": "xyz789",
"userId": "4"
}
UserDelegateAccess
Fields
| Field Name | Description |
|---|---|
colour - AccountColour!
|
|
delegateUserInfo - UserInfo!
|
|
id - ID!
|
|
isEditable - Boolean!
|
|
userId - ID!
|
Example
{
"colour": "COL1",
"delegateUserInfo": UserInfo,
"id": "4",
"isEditable": false,
"userId": "4"
}
UserDelegateAccessEntries
Fields
| Field Name | Description |
|---|---|
entries - [UserDelegateAccess!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [UserDelegateAccess],
"pageInfo": PagingInfo
}
UserEntries
Fields
| Field Name | Description |
|---|---|
adminEntries - [User!]!
|
|
entries - [UserInfo!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"adminEntries": [User],
"entries": [UserInfo],
"pageInfo": PagingInfo
}
UserGrid
UserInfo
Fields
| Field Name | Description |
|---|---|
canArchiveContactsAndCompanies - String!
|
No longer available |
canUpdateCompanyName - String!
|
No longer available |
canViewActivityViewDetail - String!
|
No longer available |
email - String!
|
|
employee - Employee
|
|
firstName - String
|
|
id - ID!
|
|
isActive - Boolean!
|
|
lastName - String
|
|
profileImageUrl - String
|
|
profileName - String!
|
|
role - RoleCode!
|
|
userId - ID!
|
Example
{
"canArchiveContactsAndCompanies": "xyz789",
"canUpdateCompanyName": "xyz789",
"canViewActivityViewDetail": "xyz789",
"email": "xyz789",
"employee": Employee,
"firstName": "xyz789",
"id": 4,
"isActive": false,
"lastName": "abc123",
"profileImageUrl": "xyz789",
"profileName": "abc123",
"role": "ADMIN",
"userId": 4
}
UsersScope
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
WebhookEvent
Fields
| Field Name | Description |
|---|---|
destinationUrl - String!
|
|
id - ID!
|
|
payload - String!
|
|
triggerEvent - WebhookTriggerEvent!
|
Example
{
"destinationUrl": "xyz789",
"id": "4",
"payload": "abc123",
"triggerEvent": "GENERIC_LISTS_ITEM_CREATED"
}
WebhookEventEntries
Fields
| Field Name | Description |
|---|---|
entries - [WebhookEvent!]!
|
|
pageInfo - PagingInfo!
|
Example
{
"entries": [WebhookEvent],
"pageInfo": PagingInfo
}
WebhookTrigger
Fields
| Field Name | Description |
|---|---|
id - ID
|
Example
{"id": 4}
WebhookTriggerEvent
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GENERIC_LISTS_ITEM_CREATED"
WhoKnowsCategory
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COLLEAGUES"
WhoKnowsFiltering
Fields
| Input Field | Description |
|---|---|
companyUid - ID
|
Company domain or company id |
connectionCategory - WhoKnowsCategory
|
Example
{
"companyUid": "4",
"connectionCategory": "COLLEAGUES"
}
WhoKnowsList
Fields
| Field Name | Description |
|---|---|
pageInfo - PagingInfo!
|
Example
{"pageInfo": PagingInfo}