Developers
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

GraphQLRepositoriesaccount

entities.account

Read account records with the account repository, and change them with the account mutations. Same records as the REST Accounts entity.

Queries

Fields of entities { account { … } }.

Each operation opens an example built from the schema and checked against it on every build. Replace the placeholders, such as <account id>, with values from your space.

KindFieldReturns
QUERYgetById(entityId: ID!)
Returns the record with the given id, or null when there is none. Deleted records are returned as well.
AccountEntity
Example
Example: getById
query AccountGetById {
  entities {
    account {
      getById(entityId: "<account id>") {
        id
        name
        formattedName
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountGetById { entities { account { getById(entityId: \"<account id>\") { id name formattedName modified } } } }"}'
QUERYgetByIds(entityIds: [ID!]!)
Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
[AccountEntity!]!
Example
Example: getByIds
query AccountGetByIds {
  entities {
    account {
      getByIds(entityIds: ["<account id>"]) {
        id
        name
        formattedName
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountGetByIds { entities { account { getByIds(entityIds: [\"<account id>\"]) { id name formattedName modified } } } }"}'
QUERYgetAll(limit: Int, offset: Int, filter: AccountFilterInput, orderBy: [AccountOrderByInput!], includeDeleted: Boolean)
Returns the records that match the filter, paged with limit and offset.
[AccountEntity!]!
Example
Example: getAll
query AccountGetAll {
  entities {
    account {
      getAll(limit: 10) {
        id
        name
        formattedName
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountGetAll { entities { account { getAll(limit: 10) { id name formattedName modified } } } }"}'
QUERYgetByCriteria(filter: AccountFilterInput, orderBy: [AccountOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)
Returns the records that match the filter as a cursor-paginated connection.
AccountEntityConnection
Example
Example: getByCriteria
query AccountGetByCriteria {
  entities {
    account {
      getByCriteria(first: 10) {
        totalCount
        edges {
          node {
            id
            name
            formattedName
            modified
          }
        }
        pageInfo {
          hasNextPage
          endCursor
        }
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountGetByCriteria { entities { account { getByCriteria(first: 10) { totalCount edges { node { id name formattedName modified } } pageInfo { hasNextPage endCursor } } } } }"}'
QUERYgetChangedFieldsSinceRevision(id: UUID!, revision: Int!)
Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.
[UUID!]!
Example
Example: getChangedFieldsSinceRevision
query AccountGetChangedFieldsSinceRevision {
  entities {
    account {
      getChangedFieldsSinceRevision(id: "<account id>", revision: 10)
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountGetChangedFieldsSinceRevision { entities { account { getChangedFieldsSinceRevision(id: \"<account id>\", revision: 10) } } }"}'
QUERYgetBySession(includedIds: [UUID!]!, excludedIds: [UUID!]!, sessionId: String!, before: String, after: String, first: Int, last: Int)
Returns a page of records selected in a list or report: all records of the given result plus the explicitly included ids, minus the excluded ids.
AccountEntityConnection
Example
Example: getBySession
query AccountGetBySession {
  entities {
    account {
      getBySession(
        includedIds: ["<account id>"]
        excludedIds: ["<account id>"]
        sessionId: "<session id>"
        first: 10
      ) {
        totalCount
        edges {
          node {
            id
            name
            formattedName
            modified
          }
        }
        pageInfo {
          hasNextPage
          endCursor
        }
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountGetBySession { entities { account { getBySession( includedIds: [\"<account id>\"] excludedIds: [\"<account id>\"] sessionId: \"<session id>\" first: 10 ) { totalCount edges { node { id name formattedName modified } } pageInfo { hasNextPage endCursor } } } } }"}'
QUERYgetByIdFormatted(id: UUID!, fieldIds: [UUID!])
Returns the values of a record's fields formatted for display, keyed by field id.
JSONString
Example
Example: getByIdFormatted
query AccountGetByIdFormatted {
  entities {
    account {
      getByIdFormatted(id: "<account id>")
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountGetByIdFormatted { entities { account { getByIdFormatted(id: \"<account id>\") } } }"}'
QUERYgetEligibleParents(accountId: UUID!, limit: Int, offset: Int, filter: AccountFilterInput, orderBy: [AccountOrderByInput!], includeDeleted: Boolean)
Returns the accounts that can be set as the parent of the given account, which excludes the account itself and all its child accounts at any level.
[AccountEntity!]!
Example
Example: getEligibleParents
query AccountGetEligibleParents {
  entities {
    account {
      getEligibleParents(accountId: "<account id>", limit: 10) {
        id
        name
        formattedName
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountGetEligibleParents { entities { account { getEligibleParents(accountId: \"<account id>\", limit: 10) { id name formattedName modified } } } }"}'
QUERYgetRelatedToContact(limit: Int, offset: Int, filter: AccountFilterInput, orderBy: [AccountOrderByInput!], contactId: UUID)
Returns the accounts linked to the given contact.
[AccountEntity!]!
Example
Example: getRelatedToContact
query AccountGetRelatedToContact {
  entities {
    account {
      getRelatedToContact(limit: 10) {
        id
        name
        formattedName
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountGetRelatedToContact { entities { account { getRelatedToContact(limit: 10) { id name formattedName modified } } } }"}'
QUERYautoPrefill(mappingId: UUID!, entityId: UUID!, targetEntityTypeId: UUID)
Returns a new, unsaved record pre-filled from a source record according to a field mapping. Nothing is saved; the returned values can be used as input for create.
AccountEntity!
Example
Example: autoPrefill
query AccountAutoPrefill {
  entities {
    account {
      autoPrefill(mappingId: "<mapping id>", entityId: "<account id>") {
        id
        name
        formattedName
        modified
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountAutoPrefill { entities { account { autoPrefill(mappingId: \"<mapping id>\", entityId: \"<account id>\") { id name formattedName modified } } } }"}'
QUERYaiAutoPrefill(actionId: String!)
Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in.
AccountAutoPrefill!
Example
Example: aiAutoPrefill
query AccountAiAutoPrefill {
  entities {
    account {
      aiAutoPrefill(actionId: "<action id>") {
        entity {
          id
          name
          formattedName
          modified
        }
        fieldIds
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query AccountAiAutoPrefill { entities { account { aiAutoPrefill(actionId: \"<action id>\") { entity { id name formattedName modified } fieldIds } } } }"}'

Mutations

KindMutationDoesReturns
MUTATIONchangeOwnershipAccount(input: ChangeOwnershipAccountInput!)Change owner GraphQL onlyChangeOwnershipAccountPayload
Example
Example: changeOwnershipAccount
mutation ChangeOwnershipAccount {
  changeOwnershipAccount(
    input: {ownerId: "<owner id>", unitId: "<unit id>", keepOwnerAsEditor: false, transferLinkedRecords: false, id: "<account id>"}
  ) {
    result {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ChangeOwnershipAccount { changeOwnershipAccount( input: {ownerId: \"<owner id>\", unitId: \"<unit id>\", keepOwnerAsEditor: false, transferLinkedRecords: false, id: \"<account id>\"} ) { result { id name formattedName modified } } }"}'
MUTATIONmanageSharingAccount(input: ManageSharingAccountInput!)Change who it is shared with GraphQL onlyManageSharingAccountPayload
Example
Example: manageSharingAccount
mutation ManageSharingAccount {
  manageSharingAccount(input: {shareMode: Standard, id: "<account id>"}) {
    result {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ManageSharingAccount { manageSharingAccount(input: {shareMode: Standard, id: \"<account id>\"}) { result { id name formattedName modified } } }"}'
MUTATIONrestoreAccount(input: RestoreAccountInput!)Restore a deleted recordRestoreAccountPayload
Example
Example: restoreAccount
mutation RestoreAccount {
  restoreAccount(input: {id: "<account id>"}) {
    result {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation RestoreAccount { restoreAccount(input: {id: \"<account id>\"}) { result { id name formattedName modified } } }"}'
MUTATIONcopyAccount(input: CopyAccountInput!)Copy a record GraphQL onlyCopyAccountPayload
Example
Example: copyAccount
mutation CopyAccount {
  copyAccount(input: {id: "<account id>"}) {
    result {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation CopyAccount { copyAccount(input: {id: \"<account id>\"}) { result { id name formattedName modified } } }"}'
MUTATIONmergeAccount(input: MergeAccountInput!)Merge duplicatesMergeAccountPayload
Example
Example: mergeAccount
mutation MergeAccount {
  mergeAccount(input: {master: {id: "<account id>"}, slaveId: "<slave id>"}) {
    result {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation MergeAccount { mergeAccount(input: {master: {id: \"<account id>\"}, slaveId: \"<slave id>\"}) { result { id name formattedName modified } } }"}'
MUTATIONarchiveAccount(input: ArchiveAccountInput!)Archive GraphQL onlyArchiveAccountPayload
Example
Example: archiveAccount
mutation ArchiveAccount {
  archiveAccount(
    input: {entity: {id: "<account id>"}, completeAllRelatedProjects: false, archiveAllRelatedLeads: false, archiveAllRelatedOpportunities: false, archiveAllRelatedQuotes: false, archiveAllRelatedContacts: false, completeAllRelatedTasks: false}
  ) {
    result {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ArchiveAccount { archiveAccount( input: {entity: {id: \"<account id>\"}, completeAllRelatedProjects: false, archiveAllRelatedLeads: false, archiveAllRelatedOpportunities: false, archiveAllRelatedQuotes: false, archiveAllRelatedContacts: false, completeAllRelatedTasks: false} ) { result { id name formattedName modified } } }"}'
MUTATIONreactivateAccount(input: ReactivateAccountInput!)Undo archive GraphQL onlyReactivateAccountPayload
Example
Example: reactivateAccount
mutation ReactivateAccount {
  reactivateAccount(input: {id: "<account id>"}) {
    result {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ReactivateAccount { reactivateAccount(input: {id: \"<account id>\"}) { result { id name formattedName modified } } }"}'
MUTATIONcreateAccount(input: CreateAccountInput!, validationLevel: [ValidationLevel!])Create one recordCreateAccountPayload
Example
Example: createAccount
mutation CreateAccount {
  createAccount(input: {name: "Northwind Analytics", ownerId: "<owner id>"}) {
    account {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation CreateAccount { createAccount(input: {name: \"Northwind Analytics\", ownerId: \"<owner id>\"}) { account { id name formattedName modified } } }"}'
MUTATIONupdateAccount(input: UpdateAccountInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)Update fieldsUpdateAccountPayload
Example
Example: updateAccount
mutation UpdateAccount {
  updateAccount(input: {id: "<account id>"}) {
    account {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation UpdateAccount { updateAccount(input: {id: \"<account id>\"}) { account { id name formattedName modified } } }"}'
MUTATIONbulkUpdateAccount(input: [CreateOrUpdateAccountInput!]!, deleteInput: [DeleteAccountInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)Create or update many; per-item resultsBulkUpdateAccountPayload
Example
Example: bulkUpdateAccount
mutation BulkUpdateAccount {
  bulkUpdateAccount(input: [{id: "<account id>"}]) {
    result {
      created {
        id
      }
      errors {
        index
        code
        message
        entityId
      }
      updated
      deleted
      errorsOnDelete {
        index
        code
        message
        entityId
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation BulkUpdateAccount { bulkUpdateAccount(input: [{id: \"<account id>\"}]) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'
MUTATIONdeleteAccount(input: DeleteAccountInput!)Soft-deleteDeleteAccountPayload
Example
Example: deleteAccount
mutation DeleteAccount {
  deleteAccount(input: {id: "<account id>"}) {
    account {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation DeleteAccount { deleteAccount(input: {id: \"<account id>\"}) { account { id name formattedName modified } } }"}'
MUTATIONbulkArchiveAccount(input: BulkArchiveAccountInput!)Archive many GraphQL onlyBulkArchiveAccountPayload
Example
Example: bulkArchiveAccount
mutation BulkArchiveAccount {
  bulkArchiveAccount(
    input: {bulkFilter: {includedIds: ["<account id>"]}, entity: {id: "<account id>"}}
  ) {
    result {
      created {
        id
      }
      errors {
        index
        code
        message
        entityId
      }
      updated
      deleted
      errorsOnDelete {
        index
        code
        message
        entityId
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation BulkArchiveAccount { bulkArchiveAccount( input: {bulkFilter: {includedIds: [\"<account id>\"]}, entity: {id: \"<account id>\"}} ) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'
MUTATIONbulkReactivateAccount(input: BulkReactivateAccountInput!)Undo archive for many GraphQL onlyBulkReactivateAccountPayload
Example
Example: bulkReactivateAccount
mutation BulkReactivateAccount {
  bulkReactivateAccount(input: {bulkFilter: {includedIds: ["<account id>"]}}) {
    result {
      created {
        id
      }
      errors {
        index
        code
        message
        entityId
      }
      updated
      deleted
      errorsOnDelete {
        index
        code
        message
        entityId
      }
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation BulkReactivateAccount { bulkReactivateAccount(input: {bulkFilter: {includedIds: [\"<account id>\"]}}) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } }"}'
MUTATIONconvertAccount(input: CreateAccountInput!, sourceEntity: EntityNameEnum!, sourceEntityId: UUID!, operation: RecordConversionOperationEnum!, options: RecordConversionOptions!, sourceEntityApiName: String, validationLevel: [ValidationLevel!])Create from another record GraphQL onlyConvertAccountPayload
Example
Example: convertAccount
mutation ConvertAccount {
  convertAccount(
    input: {name: "Northwind Analytics", ownerId: "<owner id>"}
    sourceEntity: AiAgent
    sourceEntityId: "<source entity id>"
    operation: Nothing
    options: {}
  ) {
    account {
      id
      name
      formattedName
      modified
    }
  }
}
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation ConvertAccount { convertAccount( input: {name: \"Northwind Analytics\", ownerId: \"<owner id>\"} sourceEntity: AiAgent sourceEntityId: \"<source entity id>\" operation: Nothing options: {} ) { account { id name formattedName modified } } }"}'

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

AccountEntity object 71 fields: customFields, pendingScheduledActions, isDeleteProtected, …

Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it.

FieldTypeDescription
customFieldsJSONString! (1 args)Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase).
pendingScheduledActionsIntFilled only when a single record is read by its id; otherwise null or an empty list.
isDeleteProtectedBoolean!True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
idID!Unique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
accountTypeAccountTypeEntityAccount type that classifies this account. Account types are configurable per team space and drive which form, fields and pipelines apply.
currencyExchangeRatesListCurrencyExchangeRatesListEntityCurrency exchange rate list used to convert monetary fields linked to this account. Empty to inherit the team space default.
customerTypeDataEntityCustomer category (e.g. Lead, Prospect, Customer). Configurable per team space.
industryDataEntityIndustry the account operates in. Configurable per team space.
ownerClientEntitySales user who owns this account.
parentAccountAccountEntityParent account in a corporate hierarchy. Empty for top-level accounts.
parentAccountRelationTypeParentAccountRelationTypeEntityType of relationship to the parent account (e.g. subsidiary, branch). Required when parentAccount is set.
pictureCloudObjectEntityProfile picture or company logo associated with the account.
unitSalesUnitEntitySales unit this account is assigned to. Determines which team members can see the record under unit-based sharing.
accountClassAccountClassEnumManual classification grade assigned to the account. Used in segmentation and reporting.
accountTypeIdIDId of the account type assigned to this account.
addressStringStreet address of the account.
cityStringCity of the account address.
commentsStringFree-form notes describing the account.
countryStringCountry of the account address.
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this account.
customerTypeIdIDId of the customer type (e.g. Lead, Prospect, Customer) that classifies the account.
email1StringPrimary email address of the account. Used as default recipient for emails sent from Coevera.
email2StringAdditional email address.
email3StringAdditional email address.
email4StringAdditional email address.
email5StringAdditional email address.
healthCategoryIDCoarser bucket of healthStatus used for grouping and reporting. Read-only.
healthStatusIntComputed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change.
homePageStringWebsite URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled.
industryIdIDId of the industry classification.
isArchivedBooleanTrue when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastAiAccountHierarchyAppliedDateTimeTime when an AI-suggested account hierarchy was last applied to this account.
lastAiOrgChartAppliedDateTimeTime when an AI-suggested org chart was last applied to this account.
nameString!Name of the entity and its default text representation.
ownerIdID!Id of the account owner.
parentAccountIdIDId of the parent account in the corporate hierarchy. Empty for top-level accounts.
parentAccountRelationTypeIdIDId of the parent-account relationship type.
phone1StringPrimary phone number of the account. Used as default target for click-to-call.
phone2StringAdditional phone number.
phone3StringAdditional phone number.
phone4StringAdditional phone number.
phone5StringAdditional phone number.
pictureIdIDId of the profile picture document.
quickParentAccountNameStringFree-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceStringState or province of the account address.
unitIdIDId of the sales unit.
zipCodeStringZIP or postal code of the account address.
revisionIntRevision when entity was lastly changed.
formattedNameString!Display version of the account name, used in lists and references.
enrolledEmailSequencesInt!Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
socialMediaAccountSocialRelationEntitySocial network profiles linked to this account (e.g. LinkedIn, Facebook).
sharingUnitsAccountSharingSalesUnitRelationEntityConnection (8 args)Sales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing.
sharingClientsAccountSharingClientRelationEntityConnection (8 args)Users that have been granted shared access to this account. Editable only when shareMode allows user sharing.
documentsCloudObjectRelationEntityConnection (8 args)Documents linked to this account.
isFavoriteBoolean!True when the current authenticated user has marked this account as favorite. Per-user.
viewerIdsPerSalesUnit[UUID!]!Filled only when a single record is read by its id; otherwise null or an empty list.
isUnsubscribedBooleanIf account has any unsubscribed email.
tagsTagRelationEntityConnection (8 args)Tag labels applied to this account.
staticProfilesProfileRelationEntityConnection (8 args)Saved view profiles this account currently matches.
healthEntityHealthResultComposite entity-health summary, combining current and previous state with last-calculation metadata. Read-only; computed by Coevera.
modifiedByUserDateTimeTimestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera.
instancePermissions[EntityPermsEnum!]! (1 args)Permissions the current user has on this record, out of the requested ones.
relatedEntitiesDrilldownCompactViewDrilldownModel! (1 args)Records of the given entity type that are related to this record, as a drilldown list.
charts[DashboardChartData!] (1 args)Data of the given preview pane charts and lists, computed for this record.
chartsDrilldownCompactViewDrilldownModel! (3 args)Records behind one preview pane chart of this record: all records of a list chart, or the records of a single data point of a report chart.
fields[InterfaceFieldData]! (2 args)Values of the fields shown in the record's preview pane, as configured for the record's type.
approvalApprovalEntityApproval request of this record that is pending or was rejected; null when there is none or it was approved.
AccountEntityConnection object pageInfo: PageInfo!, edges: [AccountEntityEdge]!, totalCount: Int

Paginated list of Account records.

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edges[AccountEntityEdge]!Contains the nodes in this connection.
totalCountIntTotal number of items in the connection.
AccountEntityEdge object node: AccountEntity, cursor: String!

A Relay edge containing a AccountEntity and its cursor.

FieldTypeDescription
nodeAccountEntityThe item at the end of the edge
cursorString!A cursor for use in pagination
AccountClassEnumFilterInput input eq: [AccountClassEnum!], NOT: AccountClassEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input fieldTypeDescription
eq[AccountClassEnum!]Matches any of the listed values.
NOTAccountClassEnumFilterInputMatches values that do not meet this condition.
AccountFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for Account records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input fieldTypeDescription
OR[AccountFilterInput!]Matches records that meet at least one of the listed filters.
AND[AccountFilterInput!]Matches records that meet all of the listed filters.
NOTAccountFilterInputMatches records that do not meet this filter.
globalSearchQueryStringSearch term matched against the fields that the global search covers for this entity.
idEntityFilterStringFieldUnique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedEntityFilterDateTimeFieldLast modification time.
createdEntityFilterDateTimeFieldCreation time.
accountClassAccountClassEnumFilterInputManual classification grade assigned to the account. Used in segmentation and reporting.
accountTypeIdEntityFilterStringFieldId of the account type assigned to this account.
addressEntityFilterStringFieldStreet address of the account.
cityEntityFilterStringFieldCity of the account address.
commentsEntityFilterStringFieldFree-form notes describing the account.
countryEntityFilterStringFieldCountry of the account address.
currencyExchangeRatesListIdEntityFilterStringFieldId of the currency exchange rate list applied to this account.
customerTypeIdEntityFilterStringFieldId of the customer type (e.g. Lead, Prospect, Customer) that classifies the account.
email1EntityFilterStringFieldPrimary email address of the account. Used as default recipient for emails sent from Coevera.
email2EntityFilterStringFieldAdditional email address.
email3EntityFilterStringFieldAdditional email address.
email4EntityFilterStringFieldAdditional email address.
email5EntityFilterStringFieldAdditional email address.
healthCategoryEntityFilterStringFieldCoarser bucket of healthStatus used for grouping and reporting. Read-only.
healthStatusEntityFilterNumberFieldComputed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change.
homePageEntityFilterStringFieldWebsite URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled.
industryIdEntityFilterStringFieldId of the industry classification.
isArchivedBooleanTrue when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastAiAccountHierarchyAppliedEntityFilterDateTimeFieldTime when an AI-suggested account hierarchy was last applied to this account.
lastAiOrgChartAppliedEntityFilterDateTimeFieldTime when an AI-suggested org chart was last applied to this account.
nameEntityFilterStringFieldName of the entity and its default text representation.
ownerIdEntityFilterStringFieldId of the account owner.
parentAccountIdEntityFilterStringFieldId of the parent account in the corporate hierarchy. Empty for top-level accounts.
parentAccountRelationTypeIdEntityFilterStringFieldId of the parent-account relationship type.
phone1EntityFilterStringFieldPrimary phone number of the account. Used as default target for click-to-call.
phone2EntityFilterStringFieldAdditional phone number.
phone3EntityFilterStringFieldAdditional phone number.
phone4EntityFilterStringFieldAdditional phone number.
phone5EntityFilterStringFieldAdditional phone number.
pictureIdEntityFilterStringFieldId of the profile picture document.
quickParentAccountNameEntityFilterStringFieldFree-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account.
shareModeShareModeEnumFilterInputSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceEntityFilterStringFieldState or province of the account address.
unitIdEntityFilterStringFieldId of the sales unit.
zipCodeEntityFilterStringFieldZIP or postal code of the account address.
revisionEntityFilterNumberFieldRevision when entity was lastly changed.
enrolledEmailSequencesIntNumber of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
relatedEntities[EntityFilterRelatedField]Matches records related to at least one of the listed records.
withCustom[CustomField!]Conditions on custom fields, each identified by its api name. All listed conditions must match.
accountTypeAccountTypeFilterInputAccount type that classifies this account. Account types are configurable per team space and drive which form, fields and pipelines apply. Matches records where a related record meets these conditions.
currencyExchangeRatesListCurrencyExchangeRatesListFilterInputCurrency exchange rate list used to convert monetary fields linked to this account. Empty to inherit the team space default. Matches records where a related record meets these conditions.
customerTypeDataFilterInputCustomer category (e.g. Lead, Prospect, Customer). Configurable per team space. Matches records where a related record meets these conditions.
industryDataFilterInputIndustry the account operates in. Configurable per team space. Matches records where a related record meets these conditions.
ownerClientFilterInputSales user who owns this account. Matches records where a related record meets these conditions.
parentAccountAccountFilterInputParent account in a corporate hierarchy. Empty for top-level accounts. Matches records where a related record meets these conditions.
parentAccountRelationTypeParentAccountRelationTypeFilterInputType of relationship to the parent account (e.g. subsidiary, branch). Required when parentAccount is set. Matches records where a related record meets these conditions.
pictureCloudObjectFilterInputProfile picture or company logo associated with the account. Matches records where a related record meets these conditions.
unitSalesUnitFilterInputSales unit this account is assigned to. Determines which team members can see the record under unit-based sharing. Matches records where a related record meets these conditions.
socialMediaAccountSocialRelationFilterInputSocial network profiles linked to this account (e.g. LinkedIn, Facebook). Matches records where a related record meets these conditions.
sharingUnitsAccountSharingSalesUnitRelationFilterInputSales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing. Matches records where a related record meets these conditions.
sharingClientsAccountSharingClientRelationFilterInputUsers that have been granted shared access to this account. Editable only when shareMode allows user sharing. Matches records where a related record meets these conditions.
documentsCloudObjectRelationFilterInputDocuments linked to this account. Matches records where a related record meets these conditions.
tagsTagRelationFilterInputTag labels applied to this account. Matches records where a related record meets these conditions.
staticProfilesProfileRelationFilterInputSaved view profiles this account currently matches. Matches records where a related record meets these conditions.
AccountOrderByInput input Asc or Desc per field

Sorting of Account records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
accountType[AccountTypeOrderByNestedInput!]Account type that classifies this account. Account types are configurable per team space and drive which form, fields and pipelines apply. Sorts by fields of the related record, listed in order of priority.
currencyExchangeRatesList[CurrencyExchangeRatesListOrderByNestedInput!]Currency exchange rate list used to convert monetary fields linked to this account. Empty to inherit the team space default. Sorts by fields of the related record, listed in order of priority.
customerType[DataOrderByNestedInput!]Customer category (e.g. Lead, Prospect, Customer). Configurable per team space. Sorts by fields of the related record, listed in order of priority.
industry[DataOrderByNestedInput!]Industry the account operates in. Configurable per team space. Sorts by fields of the related record, listed in order of priority.
owner[ClientOrderByNestedInput!]Sales user who owns this account. Sorts by fields of the related record, listed in order of priority.
parentAccount[AccountOrderByNestedInput!]Parent account in a corporate hierarchy. Empty for top-level accounts. Sorts by fields of the related record, listed in order of priority.
parentAccountRelationType[ParentAccountRelationTypeOrderByNestedInput!]Type of relationship to the parent account (e.g. subsidiary, branch). Required when parentAccount is set. Sorts by fields of the related record, listed in order of priority.
unit[SalesUnitOrderByNestedInput!]Sales unit this account is assigned to. Determines which team members can see the record under unit-based sharing. Sorts by fields of the related record, listed in order of priority.
accountClassOrderByEnumManual classification grade assigned to the account. Used in segmentation and reporting.
accountTypeIdOrderByEnumId of the account type assigned to this account.
addressOrderByEnumStreet address of the account.
cityOrderByEnumCity of the account address.
commentsOrderByEnumFree-form notes describing the account.
countryOrderByEnumCountry of the account address.
currencyExchangeRatesListIdOrderByEnumId of the currency exchange rate list applied to this account.
customerTypeIdOrderByEnumId of the customer type (e.g. Lead, Prospect, Customer) that classifies the account.
email1OrderByEnumPrimary email address of the account. Used as default recipient for emails sent from Coevera.
email2OrderByEnumAdditional email address.
email3OrderByEnumAdditional email address.
email4OrderByEnumAdditional email address.
email5OrderByEnumAdditional email address.
healthCategoryOrderByEnumCoarser bucket of healthStatus used for grouping and reporting. Read-only.
healthStatusOrderByEnumComputed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change.
homePageOrderByEnumWebsite URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled.
industryIdOrderByEnumId of the industry classification.
isArchivedOrderByEnumTrue when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated.
nameOrderByEnumName of the entity and its default text representation.
ownerIdOrderByEnumId of the account owner.
parentAccountIdOrderByEnumId of the parent account in the corporate hierarchy. Empty for top-level accounts.
parentAccountRelationTypeIdOrderByEnumId of the parent-account relationship type.
phone1OrderByEnumPrimary phone number of the account. Used as default target for click-to-call.
phone2OrderByEnumAdditional phone number.
phone3OrderByEnumAdditional phone number.
phone4OrderByEnumAdditional phone number.
phone5OrderByEnumAdditional phone number.
quickParentAccountNameOrderByEnumFree-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account.
shareModeOrderByEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceOrderByEnumState or province of the account address.
unitIdOrderByEnumId of the sales unit.
zipCodeOrderByEnumZIP or postal code of the account address.
revisionOrderByEnumRevision when entity was lastly changed.
enrolledEmailSequencesOrderByEnumNumber of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted).
socialMedia[AccountSocialRelationOrderByNestedInput!]Social network profiles linked to this account (e.g. LinkedIn, Facebook). Sorts by fields of the related record, listed in order of priority.
relatedEntitiesCommonEntityRepositoryOrderByEntityRelationFieldSorts records by whether they are related to the listed records.
withCustomCommonEntityRepositoryOrderByCustomFieldSorts by a custom field.
AccountSocialRelationOrderByNestedInput input 27 fields: id, isDeleted, modified, …

Sorting by a field of the related AccountSocialRelation record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity. Must match with Account id.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
angellistUrlOrderByEnumAngelList profile URL of the account.
crunchbaseUrlOrderByEnumCrunchbase profile URL of the account.
disqusUrlOrderByEnumDisqus profile URL of the account.
facebookUrlOrderByEnumFacebook profile URL of the account.
flickrUrlOrderByEnumFlickr profile URL of the account.
foursquareUrlOrderByEnumFoursquare profile URL of the account.
googlePlusUrlOrderByEnumGoogle+ profile URL of the account.
gravatarUrlOrderByEnumGravatar profile URL of the account.
kloutUrlOrderByEnumKlout profile URL of the account.
linkedinUrlOrderByEnumLinkedIn profile URL of the account.
pinterestUrlOrderByEnumPinterest profile URL of the account.
quoraUrlOrderByEnumQuora profile URL of the account.
redditUrlOrderByEnumReddit profile URL of the account.
skypeUrlOrderByEnumSkype contact URL or username of the account.
slideshareUrlOrderByEnumSlideShare profile URL of the account.
twitterUrlOrderByEnumTwitter (X) profile URL of the account.
vimeoUrlOrderByEnumVimeo profile URL of the account.
wordpressUrlOrderByEnumWordPress site URL of the account.
xingUrlOrderByEnumXING profile URL of the account.
yahooUrlOrderByEnumYahoo profile URL of the account.
yelpUrlOrderByEnumYelp business URL of the account.
youtubeUrlOrderByEnumYouTube channel URL of the account.
revisionOrderByEnumRevision when entity was lastly changed.
ArchiveAccountInput input 12 fields: entity, completeAllRelatedProjects, archiveAllRelatedLeads, …

Parameters of the archiveAccount mutation.

Input fieldTypeDescription
entityUpdateAccountInput!Id of the account and optional field values to save together with the archive.
completeAllRelatedProjectsBoolean!Completes all unfinished projects of the account.
archiveAllRelatedLeadsBoolean!Archives open leads whose primary account is this account.
archiveAllRelatedOpportunitiesBoolean!Archives open opportunities whose primary account is this account.
archiveAllRelatedQuotesBoolean!Archives open quotes whose primary account is this account.
archiveAllRelatedContactsBoolean!Archives contacts whose primary account is this account.
completeAllRelatedTasksBoolean!Marks all tasks linked to the account as completed.
completeAllRelatedContactsTasksBooleanMarks tasks of contacts whose primary account is this account as completed.
completeAllRelatedLeadsTasksBooleanMarks tasks of leads whose primary account is this account as completed.
completeAllRelatedOpportunitiesTasksBooleanMarks tasks of opportunities whose primary account is this account as completed.
completeAllRelatedQuotesTasksBooleanMarks tasks of quotes whose primary account is this account as completed.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
BulkArchiveAccountInput input 14 fields: bulkFilter, entity, completeAllRelatedProjects, …

Parameters of the bulkArchiveAccount mutation.

Input fieldTypeDescription
bulkFilterBulkOperationInput!Accounts to archive: includedIds minus excludedIds. Integrations can leave sessionId empty.
entityCreateOrUpdateAccountInput!Field values saved on every archived account.
completeAllRelatedProjectsBooleanCompletes all unfinished projects of each account.
archiveAllRelatedLeadsBooleanArchives open leads whose primary account is one of the accounts.
archiveAllRelatedOpportunitiesBooleanArchives open opportunities whose primary account is one of the accounts.
archiveAllRelatedQuotesBooleanArchives open quotes whose primary account is one of the accounts.
archiveAllRelatedContactsBooleanArchives contacts whose primary account is one of the accounts.
completeAllRelatedTasksBooleanMarks all tasks linked to each account as completed.
completeAllRelatedContactsTasksBooleanMarks tasks of the accounts' primary contacts as completed.
completeAllRelatedLeadsTasksBooleanMarks tasks of the accounts' leads as completed.
completeAllRelatedOpportunitiesTasksBooleanMarks tasks of the accounts' opportunities as completed.
completeAllRelatedQuotesTasksBooleanMarks tasks of the accounts' quotes as completed.
rollbackMethodRollbackMethodROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
BulkReactivateAccountInput input bulkFilter: BulkOperationInput!, rollbackMethod: RollbackMethod, clientMutationId: String

Parameters of the bulkReactivateAccount mutation.

Input fieldTypeDescription
bulkFilterBulkOperationInput!Records to reactivate: includedIds minus excludedIds. Integrations can leave sessionId empty.
rollbackMethodRollbackMethodROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ChangeOwnershipAccountInput input 6 fields: ownerId, unitId, keepOwnerAsEditor, …

Parameters of the changeOwnershipAccount mutation.

Input fieldTypeDescription
ownerIdID!User who becomes the new owner of the account.
unitIdID!Sales unit the account is assigned to.
keepOwnerAsEditorBoolean!When true, the previous owner (if still an active user) stays on the account as a shared user with the Editor role, and a Private sharing mode is switched to Standard.
transferLinkedRecordsBoolean!When true, the new owner and sales unit are also applied to the account's open tasks and appointments, its notes, its open leads and opportunities, its linked contacts and its direct child accounts. Linked records that cannot be transferred are skipped without failing the mutation.
idID!Identifier of the AccountEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
CopyAccountInput input skipCopySuffix: Boolean, id: ID!, clientMutationId: String

Parameters of the copyAccount mutation.

Input fieldTypeDescription
skipCopySuffixBooleanWhen true, the copy keeps the original name without the copy suffix. Defaults to false.
idID!Identifier of the AccountEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
CreateAccountInput input 46 fields: clientMutationId, modified, created, …

Field values of a new Account record.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pictureCreateCloudObjectInputProfile picture or company logo associated with the account.
accountClassAccountClassEnumManual classification grade assigned to the account. Used in segmentation and reporting.
accountTypeIdIDId of the account type assigned to this account.
addressStringStreet address of the account.
cityStringCity of the account address.
commentsStringFree-form notes describing the account.
countryStringCountry of the account address.
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this account.
customerTypeIdIDId of the customer type (e.g. Lead, Prospect, Customer) that classifies the account.
email1StringPrimary email address of the account. Used as default recipient for emails sent from Coevera.
email2StringAdditional email address.
email3StringAdditional email address.
email4StringAdditional email address.
email5StringAdditional email address.
homePageStringWebsite URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled.
industryIdIDId of the industry classification.
isArchivedBooleanTrue when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastAiAccountHierarchyAppliedDateTimeTime when an AI-suggested account hierarchy was last applied to this account.
lastAiOrgChartAppliedDateTimeTime when an AI-suggested org chart was last applied to this account.
nameString!Name of the entity and its default text representation.
ownerIdID!Id of the account owner.
parentAccountIdIDId of the parent account in the corporate hierarchy. Empty for top-level accounts.
parentAccountRelationTypeIdIDId of the parent-account relationship type.
phone1StringPrimary phone number of the account. Used as default target for click-to-call.
phone2StringAdditional phone number.
phone3StringAdditional phone number.
phone4StringAdditional phone number.
phone5StringAdditional phone number.
pictureIdIDId of the profile picture document.
quickParentAccountNameStringFree-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceStringState or province of the account address.
unitIdIDId of the sales unit.
zipCodeStringZIP or postal code of the account address.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
socialMediaCreateAccountSocialRelationNoIdBackrefInputSocial network profiles linked to this account (e.g. LinkedIn, Facebook).
sharingUnits[CreateAccountSharingSalesUnitRelationNoAccountBackrefInput!]Sales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing.
sharingClients[CreateAccountSharingClientRelationNoAccountBackrefInput!]Users that have been granted shared access to this account. Editable only when shareMode allows user sharing.
documents[CreateCloudObjectRelationNoBackrefInput!]Documents linked to this account.
isUnsubscribedBooleanIf account has any unsubscribed email.
tags[CreateTagRelationNoAccountBackrefInput!]Tag labels applied to this account.
staticProfiles[CreateProfileRelationNoAccountBackrefInput!]Saved view profiles this account currently matches.
CreateAccountSharingClientRelationNoAccountBackrefInput input 5 fields: modified, created, clientId, …

Field values of a new AccountSharingClientRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
clientIdID!Id of the user.
roleSharingRoleEnumAccess the sharing gives the user on the account: Watcher can view it, Editor can view and edit it.
revisionIntRevision when entity was lastly changed.
CreateAccountSharingSalesUnitRelationNoAccountBackrefInput input 5 fields: modified, created, role, …

Field values of a new AccountSharingSalesUnitRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
roleSharingRoleEnumAccess the sharing gives the sales unit on the account: Watcher can view it, Editor can view and edit it.
unitIdID!Id of the sales unit.
revisionIntRevision when entity was lastly changed.
CreateAccountSocialRelationNoIdBackrefInput input 29 fields: modified, created, angellistUrl, …

Field values of a new AccountSocialRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
angellistUrlStringAngelList profile URL of the account.
crunchbaseUrlStringCrunchbase profile URL of the account.
disqusUrlStringDisqus profile URL of the account.
facebookIdStringFacebook page or profile id of the account.
facebookUrlStringFacebook profile URL of the account.
flickrUrlStringFlickr profile URL of the account.
foursquareUrlStringFoursquare profile URL of the account.
googleIdStringGoogle business or profile id of the account.
googlePlusUrlStringGoogle+ profile URL of the account.
gravatarUrlStringGravatar profile URL of the account.
kloutUrlStringKlout profile URL of the account.
linkedinIdStringLinkedIn company or profile id of the account.
linkedinUrlStringLinkedIn profile URL of the account.
pinterestUrlStringPinterest profile URL of the account.
quoraUrlStringQuora profile URL of the account.
redditUrlStringReddit profile URL of the account.
skypeUrlStringSkype contact URL or username of the account.
slideshareUrlStringSlideShare profile URL of the account.
twitterIdStringTwitter (X) user id of the account.
twitterUrlStringTwitter (X) profile URL of the account.
vimeoUrlStringVimeo profile URL of the account.
wordpressUrlStringWordPress site URL of the account.
xingUrlStringXING profile URL of the account.
yahooUrlStringYahoo profile URL of the account.
yelpUrlStringYelp business URL of the account.
youtubeUrlStringYouTube channel URL of the account.
revisionIntRevision when entity was lastly changed.
CreateOrUpdateAccountInput input 47 fields: clientMutationId, id, modified, …

Field values of an Account record to create, or to update when its id is set.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idIDUnique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pictureCreateCloudObjectInputProfile picture or company logo associated with the account.
accountClassAccountClassEnumManual classification grade assigned to the account. Used in segmentation and reporting.
accountTypeIdIDId of the account type assigned to this account.
addressStringStreet address of the account.
cityStringCity of the account address.
commentsStringFree-form notes describing the account.
countryStringCountry of the account address.
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this account.
customerTypeIdIDId of the customer type (e.g. Lead, Prospect, Customer) that classifies the account.
email1StringPrimary email address of the account. Used as default recipient for emails sent from Coevera.
email2StringAdditional email address.
email3StringAdditional email address.
email4StringAdditional email address.
email5StringAdditional email address.
homePageStringWebsite URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled.
industryIdIDId of the industry classification.
isArchivedBooleanTrue when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastAiAccountHierarchyAppliedDateTimeTime when an AI-suggested account hierarchy was last applied to this account.
lastAiOrgChartAppliedDateTimeTime when an AI-suggested org chart was last applied to this account.
nameStringName of the entity and its default text representation.
ownerIdIDId of the account owner.
parentAccountIdIDId of the parent account in the corporate hierarchy. Empty for top-level accounts.
parentAccountRelationTypeIdIDId of the parent-account relationship type.
phone1StringPrimary phone number of the account. Used as default target for click-to-call.
phone2StringAdditional phone number.
phone3StringAdditional phone number.
phone4StringAdditional phone number.
phone5StringAdditional phone number.
pictureIdIDId of the profile picture document.
quickParentAccountNameStringFree-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceStringState or province of the account address.
unitIdIDId of the sales unit.
zipCodeStringZIP or postal code of the account address.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
socialMediaUpdateAccountSocialRelationNoIdBackrefInputSocial network profiles linked to this account (e.g. LinkedIn, Facebook).
sharingUnits[CreateAccountSharingSalesUnitRelationNoAccountBackrefInput!]Sales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing.
sharingClients[CreateAccountSharingClientRelationNoAccountBackrefInput!]Users that have been granted shared access to this account. Editable only when shareMode allows user sharing.
documents[CreateCloudObjectRelationNoBackrefInput!]Documents linked to this account.
isUnsubscribedBooleanIf account has any unsubscribed email.
tags[CreateTagRelationNoAccountBackrefInput!]Tag labels applied to this account.
staticProfiles[CreateProfileRelationNoAccountBackrefInput!]Saved view profiles this account currently matches.
CreateProfileRelationNoAccountBackrefInput input 8 fields: modified, created, contactId, …

Field values of a new ProfileRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
contactIdIDId of the linked contact.
customEntityIdIDId of the linked custom entity record.
leadOpptyIdIDId of the linked lead or opportunity, or empty when not pointing to one.
profileIdID!Id of the screen profile.
projectIdIDId of the linked project.
quoteIdIDId of the linked quote.
CreateTagRelationNoAccountBackrefInput input 15 fields: modified, created, appointmentId, …

Field values of a new TagRelation record, created together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
appointmentIdIDId of the linked appointment.
contactIdIDId of the linked contact.
customEntityIdIDId of the linked custom entity record.
emailIdIDId of the linked email.
leadIdIDId of the linked lead.
opptyIdIDId of the linked opportunity.
processIdIDId of the linked sales process.
projectIdIDId of the linked project.
quoteIdIDId of the linked quote.
solutionIdIDId of the linked solution.
tagIdID!Id of the tag attached to the record.
taskIdIDId of the linked task.
revisionIntRevision when entity was lastly changed.
DeleteAccountInput input clientMutationId: String, id: ID!

Id of the Account record to delete.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idID!Unique identifier of entity.
ManageSharingAccountInput input 5 fields: shareMode, sharingClients, sharingUnits, …

Parameters of the manageSharingAccount mutation.

Input fieldTypeDescription
shareModeShareModeEnum!Sharing mode of the record: Standard, Private, AllView or AllEdit.
sharingClients[CreateAccountSharingClientRelationNoAccountBackrefInput!]Users the record is shared with, each with the Watcher (view) or Editor (edit) role. Send an empty list to remove all shared users.
sharingUnits[CreateAccountSharingSalesUnitRelationNoAccountBackrefInput!]Sales units the record is shared with, each with the Watcher or Editor role. Send an empty list to remove all shared units.
idID!Identifier of the AccountEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
MergeAccountInput input master: UpdateAccountInput!, slaveId: ID!, clientMutationId: String

Parameters of the mergeAccount mutation.

Input fieldTypeDescription
masterUpdateAccountInput!Id of the account to keep and the field values it should end up with.
slaveIdID!Id of the duplicate account that is merged into the master and then deleted.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ParentAccountRelationTypeOrderByNestedInput input 7 fields: id, isDeleted, modified, …

Sorting by a field of the related ParentAccountRelationType record. Set exactly one field in each item.

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
childLabelOrderByEnumLabel shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company).
parentLabelOrderByEnumLabel shown for the parent side of the parent-child account relation (e.g. "Parent company").
revisionOrderByEnumRevision when entity was lastly changed.
ReactivateAccountInput input id: UUID!, clientMutationId: String

Parameters of the reactivateAccount mutation.

Input fieldTypeDescription
idUUID!Id of the archived account.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
RestoreAccountInput input id: ID!, clientMutationId: String

Parameters of the restoreAccount mutation.

Input fieldTypeDescription
idID!Identifier of the AccountEntity to perform the action on.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
UpdateAccountInput input 47 fields: clientMutationId, id, modified, …

Id of an Account record and the field values to change.

Input fieldTypeDescription
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
idID!Unique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pictureCreateCloudObjectInputProfile picture or company logo associated with the account.
accountClassAccountClassEnumManual classification grade assigned to the account. Used in segmentation and reporting.
accountTypeIdIDId of the account type assigned to this account.
addressStringStreet address of the account.
cityStringCity of the account address.
commentsStringFree-form notes describing the account.
countryStringCountry of the account address.
currencyExchangeRatesListIdIDId of the currency exchange rate list applied to this account.
customerTypeIdIDId of the customer type (e.g. Lead, Prospect, Customer) that classifies the account.
email1StringPrimary email address of the account. Used as default recipient for emails sent from Coevera.
email2StringAdditional email address.
email3StringAdditional email address.
email4StringAdditional email address.
email5StringAdditional email address.
homePageStringWebsite URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled.
industryIdIDId of the industry classification.
isArchivedBooleanTrue when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated.
lastAiAccountHierarchyAppliedDateTimeTime when an AI-suggested account hierarchy was last applied to this account.
lastAiOrgChartAppliedDateTimeTime when an AI-suggested org chart was last applied to this account.
nameStringName of the entity and its default text representation.
ownerIdIDId of the account owner.
parentAccountIdIDId of the parent account in the corporate hierarchy. Empty for top-level accounts.
parentAccountRelationTypeIdIDId of the parent-account relationship type.
phone1StringPrimary phone number of the account. Used as default target for click-to-call.
phone2StringAdditional phone number.
phone3StringAdditional phone number.
phone4StringAdditional phone number.
phone5StringAdditional phone number.
pictureIdIDId of the profile picture document.
quickParentAccountNameStringFree-text parent-account name used when the parent has not been linked to an actual Account record. Lets integrators note the relationship without creating a separate parent Account.
shareModeShareModeEnumSharing model applied on top of the owner/unit visibility (e.g. shared with selected sales units or selected users). The matching sharingUnits / sharingClients lists control who is granted access.
stateProvinceStringState or province of the account address.
unitIdIDId of the sales unit.
zipCodeStringZIP or postal code of the account address.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
socialMediaUpdateAccountSocialRelationNoIdBackrefInputSocial network profiles linked to this account (e.g. LinkedIn, Facebook).
sharingUnits[CreateAccountSharingSalesUnitRelationNoAccountBackrefInput!]Sales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing.
sharingClients[CreateAccountSharingClientRelationNoAccountBackrefInput!]Users that have been granted shared access to this account. Editable only when shareMode allows user sharing.
documents[CreateCloudObjectRelationNoBackrefInput!]Documents linked to this account.
isUnsubscribedBooleanIf account has any unsubscribed email.
tags[CreateTagRelationNoAccountBackrefInput!]Tag labels applied to this account.
staticProfiles[CreateProfileRelationNoAccountBackrefInput!]Saved view profiles this account currently matches.
UpdateAccountSocialRelationNoIdBackrefInput input 29 fields: modified, created, angellistUrl, …

Id of an AccountSocialRelation record and the field values to change, updated together with the record it belongs to.

Input fieldTypeDescription
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
angellistUrlStringAngelList profile URL of the account.
crunchbaseUrlStringCrunchbase profile URL of the account.
disqusUrlStringDisqus profile URL of the account.
facebookIdStringFacebook page or profile id of the account.
facebookUrlStringFacebook profile URL of the account.
flickrUrlStringFlickr profile URL of the account.
foursquareUrlStringFoursquare profile URL of the account.
googleIdStringGoogle business or profile id of the account.
googlePlusUrlStringGoogle+ profile URL of the account.
gravatarUrlStringGravatar profile URL of the account.
kloutUrlStringKlout profile URL of the account.
linkedinIdStringLinkedIn company or profile id of the account.
linkedinUrlStringLinkedIn profile URL of the account.
pinterestUrlStringPinterest profile URL of the account.
quoraUrlStringQuora profile URL of the account.
redditUrlStringReddit profile URL of the account.
skypeUrlStringSkype contact URL or username of the account.
slideshareUrlStringSlideShare profile URL of the account.
twitterIdStringTwitter (X) user id of the account.
twitterUrlStringTwitter (X) profile URL of the account.
vimeoUrlStringVimeo profile URL of the account.
wordpressUrlStringWordPress site URL of the account.
xingUrlStringXING profile URL of the account.
yahooUrlStringYahoo profile URL of the account.
yelpUrlStringYelp business URL of the account.
youtubeUrlStringYouTube channel URL of the account.
revisionIntRevision when entity was lastly changed.
ArchiveAccountPayload object result: AccountEntity, clientMutationId: String

Result of the archiveAccount mutation.

FieldTypeDescription
resultAccountEntityThe archived account.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
BulkArchiveAccountPayload object result: BulkUpdateResults!, clientMutationId: String

Result of the bulkArchiveAccount mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the archived accounts and the items that failed.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
BulkReactivateAccountPayload object result: BulkUpdateResults!, clientMutationId: String

Result of the bulkReactivateAccount mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the reactivated records and the items that failed.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
BulkUpdateAccountPayload object result: BulkUpdateResults!

Result of the bulkUpdateAccount mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the created, updated and deleted records, and the items that failed.
ChangeOwnershipAccountPayload object result: AccountEntity, clientMutationId: String

Result of the changeOwnershipAccount mutation.

FieldTypeDescription
resultAccountEntityThe account with its new owner.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ConvertAccountPayload object account: AccountEntity!, clientMutationId: String

Result of the convertAccount mutation.

FieldTypeDescription
accountAccountEntity!The created record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
CopyAccountPayload object result: AccountEntity, clientMutationId: String

Result of the copyAccount mutation.

FieldTypeDescription
resultAccountEntityThe new account.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
CreateAccountPayload object account: AccountEntity, clientMutationId: String

Result of the createAccount mutation.

FieldTypeDescription
accountAccountEntityThe created record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
DeleteAccountPayload object account: AccountEntity, clientMutationId: String

Result of the deleteAccount mutation.

FieldTypeDescription
accountAccountEntityThe deleted record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ManageSharingAccountPayload object result: AccountEntity, clientMutationId: String

Result of the manageSharingAccount mutation.

FieldTypeDescription
resultAccountEntityThe record with its updated sharing.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
MergeAccountPayload object result: AccountEntity, clientMutationId: String

Result of the mergeAccount mutation.

FieldTypeDescription
resultAccountEntityThe merged master account.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
ReactivateAccountPayload object result: AccountEntity, clientMutationId: String

Result of the reactivateAccount mutation.

FieldTypeDescription
resultAccountEntityThe reactivated account.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
RestoreAccountPayload object result: AccountEntity, clientMutationId: String

Result of the restoreAccount mutation.

FieldTypeDescription
resultAccountEntityThe restored record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
UpdateAccountPayload object account: AccountEntity, clientMutationId: String

Result of the updateAccount mutation.

FieldTypeDescription
accountAccountEntityThe updated record.
clientMutationIdStringOptional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
AccountAutoPrefill object entity: AccountEntity, fieldIds: [UUID!]!

New, unsaved account pre-filled with the values of an AI suggestion, with the ids of the fields that were filled in.

FieldTypeDescription
entityAccountEntityNew account carrying the pre-filled values; it is not saved.
fieldIds[UUID!]!Ids of the fields that were filled in.
AccountClassEnum enum NoClass, ClassA, ClassB, ClassC, ClassD

Classification grade of an account.

ValueDescription
NoClassThe account is not classified.
ClassAMost valuable accounts (class A).
ClassBSecond most valuable accounts (class B).
ClassCThird most valuable accounts (class C).
ClassDLeast valuable accounts (class D).
EntityHealthFieldFilterRule object 6 fields: id, field, operator, …

Rule of a health indicator: a condition on a field and the score a record gets when it matches.

FieldTypeDescription
idUUID!Unique identifier of the health indicator rule.
fieldString!Identifier of the field this rule evaluates when computing the health score.
operatorFieldOperatorComparison operator applied between the field value and the rule values, such as equals, contains, or between.
values[[String]]Values the field is compared against. The outer list holds OR groups; each inner list holds the operands for a single comparison.
descriptionString!Human-readable label describing what this health indicator measures.
scoreInt!-1 for critical, otherwise choose between 0 and 100
EntityHealthIndicator object id: ID!, rule: EntityHealthFieldFilterRule!, indicator: EntityHealthIndicatorEnum!, value: JSONString

Result of one health indicator rule for a record.

FieldTypeDescription
idID!Id of the health indicator rule.
ruleEntityHealthFieldFilterRule!Health indicator rule that was evaluated.
indicatorEntityHealthIndicatorEnum!Result of the rule for the record.
valueJSONStringValue of the evaluated field on the record at the time of the calculation.
EntityHealthIndicatorEnum enum Ok, Error, Critical

Result of one health indicator rule for a record.

ValueDescription
OkThe record meets the rule.
ErrorThe record does not meet the rule and loses its points.
CriticalThe record does not meet a critical rule, which puts it in the critical health category.
EntityHealthResult object score: Int!, trend: EntityHealthTrendEnum!, indicators: [EntityHealthIndicator!]!, lastCalculation: DateTime!

Health of a record: its score, its trend and the result of each indicator rule.

FieldTypeDescription
scoreInt!Health score of the record from 0 to 100: the share of the points of the met rules. -1 when a critical rule is not met.
trendEntityHealthTrendEnum!How the score changed compared with the previous calculation.
indicators[EntityHealthIndicator!]!Result of each health indicator rule, the rules that are not met first.
lastCalculationDateTime!When the health of the record was last calculated.
EntityHealthTrendEnum enum Increasing, Decreasing, NoChange, Critical

How a record's health score changed compared with the previous calculation.

ValueDescription
IncreasingThe score went up.
DecreasingThe score went down.
NoChangeThe score stayed the same, or there is no earlier score.
CriticalThe score falls into the critical health category.
FieldFilterRule object id: UUID, field: String!, operator: FieldOperator, values: [[String]]

Filter condition that compares one field with a set of values.

FieldTypeDescription
idUUIDIdentifier of this condition within the filter box. Used to reference the condition from the box formula.
fieldString!Identifier of the field this condition is evaluated against.
operatorFieldOperatorComparison applied between the field and the supplied values (for example Is, IsNot, Contains, Between, IsEmpty).
values[[String]]Values the field is compared against. The outer list holds alternatives combined with OR; the inner list holds the parts of a single value (such as the two bounds of a Between comparison).
FieldOperator enum Nop, Is, IsNot, IsEmpty, IsNotEmpty, Less, … (23 values)

Comparison applied between a field and the supplied values in a filter condition or formatting rule.

ValueDescription
NopFor checkbox fields only: matches records where the checkbox is checked (or unchecked when the value is false).
IsField equals the value; text comparison ignores case.
IsNotField does not equal the value, including records where the field is empty.
IsEmptyField has no value; no comparison value is needed.
IsNotEmptyField has a value; no comparison value is needed.
LessField is less than the value.
LessOrEqualField is less than or equal to the value.
MoreField is greater than the value.
MoreOrEqualField is greater than or equal to the value.
BetweenField lies between the two values, bounds included; an omitted bound leaves that side open.
BetweenNotField lies outside the two values or is empty.
ContainsField contains the value as a substring, ignoring case.
ContainsNotField does not contain the value as a substring, or is empty.
HasMulti-value field contains all of the listed values.
HasNotMulti-value field does not contain all of the listed values, or is empty.
RelativePeriodDate field falls within a dynamic period given by a PeriodKind value (for example MonthCurrent), evaluated relative to today.
RelativePeriodNotDate field falls outside the given dynamic period.
InField matches at least one of the listed values.
InNotField matches none of the listed values, or is empty.
StartsWithText field starts with the value, ignoring case.
EndsWithText field ends with the value, ignoring case.
IsActiveFor owner fields: the owner is an active user.
IsNotActiveFor owner fields: the owner is a deactivated user.
FilterFieldRuleInterface interface id: UUID, field: String!, operator: FieldOperator, values: [[String]]

Single filter condition: the field, the comparison operator and the values it is compared with.

FieldTypeDescription
idUUIDIdentifier of this condition within the filter box. Used to reference the condition from the box formula.
fieldString!Identifier of the field this condition is evaluated against.
operatorFieldOperatorComparison applied between the field and the supplied values (for example Is, IsNot, Contains, Between, IsEmpty).
values[[String]]Values the field is compared against. The outer list holds alternatives combined with OR; the inner list holds the parts of a single value (such as the two bounds of a Between comparison).