--- title: entities.account description: Read account records with the account repository, and change them with the account mutations. Same records as the REST Accounts entity. canonical: https://developers.coevera.com/reference/graphql/account/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # entities.account Read account records with the account repository, and change them with the account mutations. Same records as the REST Accounts entity. REST: [Accounts](https://developers.coevera.com/reference/rest/accounts.md). ## Queries - `getById(entityId: ID!): AccountEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [AccountEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well. - `getAll(limit: Int, offset: Int, filter: AccountFilterInput, orderBy: [AccountOrderByInput!], includeDeleted: Boolean): [AccountEntity!]!` Returns the records that match the filter, paged with limit and offset. - `getByCriteria(filter: AccountFilterInput, orderBy: [AccountOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): AccountEntityConnection` Returns the records that match the filter as a cursor-paginated connection. - `getChangedFieldsSinceRevision(id: UUID!, revision: Int!): [UUID!]!` Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking. - `getBySession(includedIds: [UUID!]!, excludedIds: [UUID!]!, sessionId: String!, before: String, after: String, first: Int, last: Int): AccountEntityConnection` 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. - `getByIdFormatted(id: UUID!, fieldIds: [UUID!]): JSONString` Returns the values of a record's fields formatted for display, keyed by field id. - `getEligibleParents(accountId: UUID!, limit: Int, offset: Int, filter: AccountFilterInput, orderBy: [AccountOrderByInput!], includeDeleted: Boolean): [AccountEntity!]!` 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. - `getRelatedToContact(limit: Int, offset: Int, filter: AccountFilterInput, orderBy: [AccountOrderByInput!], contactId: UUID): [AccountEntity!]!` Returns the accounts linked to the given contact. - `autoPrefill(mappingId: UUID!, entityId: UUID!, targetEntityTypeId: UUID): AccountEntity!` 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. - `aiAutoPrefill(actionId: String!): AccountAutoPrefill!` Returns an unsaved record pre-filled with the values proposed by an AI record suggestion, together with the fields the suggestion filled in. ## Mutations - `changeOwnershipAccount(input: ChangeOwnershipAccountInput!): ChangeOwnershipAccountPayload` Change owner. GraphQL only. - `manageSharingAccount(input: ManageSharingAccountInput!): ManageSharingAccountPayload` Change who it is shared with. GraphQL only. - `restoreAccount(input: RestoreAccountInput!): RestoreAccountPayload` Restore a deleted record. - `copyAccount(input: CopyAccountInput!): CopyAccountPayload` Copy a record. GraphQL only. - `mergeAccount(input: MergeAccountInput!): MergeAccountPayload` Merge duplicates. - `archiveAccount(input: ArchiveAccountInput!): ArchiveAccountPayload` Archive. GraphQL only. - `reactivateAccount(input: ReactivateAccountInput!): ReactivateAccountPayload` Undo archive. GraphQL only. - `createAccount(input: CreateAccountInput!, validationLevel: [ValidationLevel!]): CreateAccountPayload` Create one record. - `updateAccount(input: UpdateAccountInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateAccountPayload` Update fields. - `bulkUpdateAccount(input: [CreateOrUpdateAccountInput!]!, deleteInput: [DeleteAccountInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateAccountPayload` Create or update many; per-item results. - `deleteAccount(input: DeleteAccountInput!): DeleteAccountPayload` Soft-delete. - `bulkArchiveAccount(input: BulkArchiveAccountInput!): BulkArchiveAccountPayload` Archive many. GraphQL only. - `bulkReactivateAccount(input: BulkReactivateAccountInput!): BulkReactivateAccountPayload` Undo archive for many. GraphQL only. - `convertAccount(input: CreateAccountInput!, sourceEntity: EntityNameEnum!, sourceEntityId: UUID!, operation: RecordConversionOperationEnum!, options: RecordConversionOptions!, sourceEntityApiName: String, validationLevel: [ValidationLevel!]): ConvertAccountPayload` Create from another record. GraphQL only. ## Types ### AccountEntity (object) Company or organization the sales team works with; contacts, leads, opportunities and activities are linked to it. - `customFields: JSONString! (1 args)` Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase). - `pendingScheduledActions: Int` Filled only when a single record is read by its id; otherwise null or an empty list. - `isDeleteProtected: Boolean!` 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. - `id: ID!` Unique identifier of entity. - `isDeleted: Boolean` Specifies if the entity is considered deleted. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `accountType: AccountTypeEntity` Account type that classifies this account. Account types are configurable per team space and drive which form, fields and pipelines apply. - `currencyExchangeRatesList: CurrencyExchangeRatesListEntity` Currency exchange rate list used to convert monetary fields linked to this account. Empty to inherit the team space default. - `customerType: DataEntity` Customer category (e.g. Lead, Prospect, Customer). Configurable per team space. - `industry: DataEntity` Industry the account operates in. Configurable per team space. - `owner: ClientEntity` Sales user who owns this account. - `parentAccount: AccountEntity` Parent account in a corporate hierarchy. Empty for top-level accounts. - `parentAccountRelationType: ParentAccountRelationTypeEntity` Type of relationship to the parent account (e.g. subsidiary, branch). Required when parentAccount is set. - `picture: CloudObjectEntity` Profile picture or company logo associated with the account. - `unit: SalesUnitEntity` Sales unit this account is assigned to. Determines which team members can see the record under unit-based sharing. - `accountClass: AccountClassEnum` Manual classification grade assigned to the account. Used in segmentation and reporting. - `accountTypeId: ID` Id of the account type assigned to this account. - `address: String` Street address of the account. - `city: String` City of the account address. - `comments: String` Free-form notes describing the account. - `country: String` Country of the account address. - `currencyExchangeRatesListId: ID` Id of the currency exchange rate list applied to this account. - `customerTypeId: ID` Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. - `email1: String` Primary email address of the account. Used as default recipient for emails sent from Coevera. - `email2: String` Additional email address. - `email3: String` Additional email address. - `email4: String` Additional email address. - `email5: String` Additional email address. - `healthCategory: ID` Coarser bucket of healthStatus used for grouping and reporting. Read-only. - `healthStatus: Int` Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change. - `homePage: String` Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. - `industryId: ID` Id of the industry classification. - `isArchived: Boolean` True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. - `lastAiAccountHierarchyApplied: DateTime` Time when an AI-suggested account hierarchy was last applied to this account. - `lastAiOrgChartApplied: DateTime` Time when an AI-suggested org chart was last applied to this account. - `name: String!` Name of the entity and its default text representation. - `ownerId: ID!` Id of the account owner. - `parentAccountId: ID` Id of the parent account in the corporate hierarchy. Empty for top-level accounts. - `parentAccountRelationTypeId: ID` Id of the parent-account relationship type. - `phone1: String` Primary phone number of the account. Used as default target for click-to-call. - `phone2: String` Additional phone number. - `phone3: String` Additional phone number. - `phone4: String` Additional phone number. - `phone5: String` Additional phone number. - `pictureId: ID` Id of the profile picture document. - `quickParentAccountName: String` Free-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. - `shareMode: ShareModeEnum` Sharing 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. - `stateProvince: String` State or province of the account address. - `unitId: ID` Id of the sales unit. - `zipCode: String` ZIP or postal code of the account address. - `revision: Int` Revision when entity was lastly changed. - `formattedName: String!` Display version of the account name, used in lists and references. - `enrolledEmailSequences: Int!` Number of email sequences this record is currently actively enrolled in (soft-deleted or ended enrollments are not counted). - `socialMedia: AccountSocialRelationEntity` Social network profiles linked to this account (e.g. LinkedIn, Facebook). - `sharingUnits: AccountSharingSalesUnitRelationEntityConnection (8 args)` Sales units that have been granted shared access to this account. Editable only when shareMode allows unit sharing. - `sharingClients: AccountSharingClientRelationEntityConnection (8 args)` Users that have been granted shared access to this account. Editable only when shareMode allows user sharing. - `documents: CloudObjectRelationEntityConnection (8 args)` Documents linked to this account. - `isFavorite: Boolean!` 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. - `isUnsubscribed: Boolean` If account has any unsubscribed email. - `tags: TagRelationEntityConnection (8 args)` Tag labels applied to this account. - `staticProfiles: ProfileRelationEntityConnection (8 args)` Saved view profiles this account currently matches. - `health: EntityHealthResult` Composite entity-health summary, combining current and previous state with last-calculation metadata. Read-only; computed by Coevera. - `modifiedByUser: DateTime` Timestamp 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. - `relatedEntitiesDrilldown: CompactViewDrilldownModel! (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. - `chartsDrilldown: CompactViewDrilldownModel! (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. - `approval: ApprovalEntity` Approval request of this record that is pending or was rejected; null when there is none or it was approved. ### AccountEntityConnection (object) Paginated list of Account records. - `pageInfo: PageInfo!` Pagination data for this connection. - `edges: [AccountEntityEdge]!` Contains the nodes in this connection. - `totalCount: Int` Total number of items in the connection. ### AccountEntityEdge (object) A Relay edge containing a `AccountEntity` and its cursor. - `node: AccountEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### AccountClassEnumFilterInput (input) Conditions on an enumeration field. Several conditions given together must all match. - `eq: [AccountClassEnum!]` Matches any of the listed values. - `NOT: AccountClassEnumFilterInput` Matches values that do not meet this condition. ### AccountFilterInput (input) Filter conditions for Account records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `OR: [AccountFilterInput!]` Matches records that meet at least one of the listed filters. - `AND: [AccountFilterInput!]` Matches records that meet all of the listed filters. - `NOT: AccountFilterInput` Matches records that do not meet this filter. - `globalSearchQuery: String` Search term matched against the fields that the global search covers for this entity. - `id: EntityFilterStringField` Unique identifier of entity. - `isDeleted: Boolean` Specifies if the entity is considered deleted. - `modified: EntityFilterDateTimeField` Last modification time. - `created: EntityFilterDateTimeField` Creation time. - `accountClass: AccountClassEnumFilterInput` Manual classification grade assigned to the account. Used in segmentation and reporting. - `accountTypeId: EntityFilterStringField` Id of the account type assigned to this account. - `address: EntityFilterStringField` Street address of the account. - `city: EntityFilterStringField` City of the account address. - `comments: EntityFilterStringField` Free-form notes describing the account. - `country: EntityFilterStringField` Country of the account address. - `currencyExchangeRatesListId: EntityFilterStringField` Id of the currency exchange rate list applied to this account. - `customerTypeId: EntityFilterStringField` Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. - `email1: EntityFilterStringField` Primary email address of the account. Used as default recipient for emails sent from Coevera. - `email2: EntityFilterStringField` Additional email address. - `email3: EntityFilterStringField` Additional email address. - `email4: EntityFilterStringField` Additional email address. - `email5: EntityFilterStringField` Additional email address. - `healthCategory: EntityFilterStringField` Coarser bucket of healthStatus used for grouping and reporting. Read-only. - `healthStatus: EntityFilterNumberField` Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change. - `homePage: EntityFilterStringField` Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. - `industryId: EntityFilterStringField` Id of the industry classification. - `isArchived: Boolean` True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. - `lastAiAccountHierarchyApplied: EntityFilterDateTimeField` Time when an AI-suggested account hierarchy was last applied to this account. - `lastAiOrgChartApplied: EntityFilterDateTimeField` Time when an AI-suggested org chart was last applied to this account. - `name: EntityFilterStringField` Name of the entity and its default text representation. - `ownerId: EntityFilterStringField` Id of the account owner. - `parentAccountId: EntityFilterStringField` Id of the parent account in the corporate hierarchy. Empty for top-level accounts. - `parentAccountRelationTypeId: EntityFilterStringField` Id of the parent-account relationship type. - `phone1: EntityFilterStringField` Primary phone number of the account. Used as default target for click-to-call. - `phone2: EntityFilterStringField` Additional phone number. - `phone3: EntityFilterStringField` Additional phone number. - `phone4: EntityFilterStringField` Additional phone number. - `phone5: EntityFilterStringField` Additional phone number. - `pictureId: EntityFilterStringField` Id of the profile picture document. - `quickParentAccountName: EntityFilterStringField` Free-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. - `shareMode: ShareModeEnumFilterInput` Sharing 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. - `stateProvince: EntityFilterStringField` State or province of the account address. - `unitId: EntityFilterStringField` Id of the sales unit. - `zipCode: EntityFilterStringField` ZIP or postal code of the account address. - `revision: EntityFilterNumberField` Revision when entity was lastly changed. - `enrolledEmailSequences: Int` Number 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. - `accountType: AccountTypeFilterInput` Account 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. - `currencyExchangeRatesList: CurrencyExchangeRatesListFilterInput` Currency 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. - `customerType: DataFilterInput` Customer category (e.g. Lead, Prospect, Customer). Configurable per team space. Matches records where a related record meets these conditions. - `industry: DataFilterInput` Industry the account operates in. Configurable per team space. Matches records where a related record meets these conditions. - `owner: ClientFilterInput` Sales user who owns this account. Matches records where a related record meets these conditions. - `parentAccount: AccountFilterInput` Parent account in a corporate hierarchy. Empty for top-level accounts. Matches records where a related record meets these conditions. - `parentAccountRelationType: ParentAccountRelationTypeFilterInput` Type of relationship to the parent account (e.g. subsidiary, branch). Required when parentAccount is set. Matches records where a related record meets these conditions. - `picture: CloudObjectFilterInput` Profile picture or company logo associated with the account. Matches records where a related record meets these conditions. - `unit: SalesUnitFilterInput` Sales 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. - `socialMedia: AccountSocialRelationFilterInput` Social network profiles linked to this account (e.g. LinkedIn, Facebook). Matches records where a related record meets these conditions. - `sharingUnits: AccountSharingSalesUnitRelationFilterInput` Sales 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. - `sharingClients: AccountSharingClientRelationFilterInput` Users 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. - `documents: CloudObjectRelationFilterInput` Documents linked to this account. Matches records where a related record meets these conditions. - `tags: TagRelationFilterInput` Tag labels applied to this account. Matches records where a related record meets these conditions. - `staticProfiles: ProfileRelationFilterInput` Saved view profiles this account currently matches. Matches records where a related record meets these conditions. ### AccountOrderByInput (input) Sorting of Account records. Set exactly one field in each item; list several items to sort by more fields, in order of priority. - `id: OrderByEnum` Unique identifier of entity. - `isDeleted: OrderByEnum` Specifies if the entity is considered deleted. - `modified: OrderByEnum` Last modification time. - `created: OrderByEnum` Creation 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. - `accountClass: OrderByEnum` Manual classification grade assigned to the account. Used in segmentation and reporting. - `accountTypeId: OrderByEnum` Id of the account type assigned to this account. - `address: OrderByEnum` Street address of the account. - `city: OrderByEnum` City of the account address. - `comments: OrderByEnum` Free-form notes describing the account. - `country: OrderByEnum` Country of the account address. - `currencyExchangeRatesListId: OrderByEnum` Id of the currency exchange rate list applied to this account. - `customerTypeId: OrderByEnum` Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. - `email1: OrderByEnum` Primary email address of the account. Used as default recipient for emails sent from Coevera. - `email2: OrderByEnum` Additional email address. - `email3: OrderByEnum` Additional email address. - `email4: OrderByEnum` Additional email address. - `email5: OrderByEnum` Additional email address. - `healthCategory: OrderByEnum` Coarser bucket of healthStatus used for grouping and reporting. Read-only. - `healthStatus: OrderByEnum` Computed entity-health state (e.g. healthy, at-risk). Read-only; recalculated by Coevera when relevant fields change. - `homePage: OrderByEnum` Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. - `industryId: OrderByEnum` Id of the industry classification. - `isArchived: OrderByEnum` True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. - `name: OrderByEnum` Name of the entity and its default text representation. - `ownerId: OrderByEnum` Id of the account owner. - `parentAccountId: OrderByEnum` Id of the parent account in the corporate hierarchy. Empty for top-level accounts. - `parentAccountRelationTypeId: OrderByEnum` Id of the parent-account relationship type. - `phone1: OrderByEnum` Primary phone number of the account. Used as default target for click-to-call. - `phone2: OrderByEnum` Additional phone number. - `phone3: OrderByEnum` Additional phone number. - `phone4: OrderByEnum` Additional phone number. - `phone5: OrderByEnum` Additional phone number. - `quickParentAccountName: OrderByEnum` Free-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. - `shareMode: OrderByEnum` Sharing 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. - `stateProvince: OrderByEnum` State or province of the account address. - `unitId: OrderByEnum` Id of the sales unit. - `zipCode: OrderByEnum` ZIP or postal code of the account address. - `revision: OrderByEnum` Revision when entity was lastly changed. - `enrolledEmailSequences: OrderByEnum` Number 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. - `relatedEntities: CommonEntityRepositoryOrderByEntityRelationField` Sorts records by whether they are related to the listed records. - `withCustom: CommonEntityRepositoryOrderByCustomField` Sorts by a custom field. ### AccountSocialRelationOrderByNestedInput (input) Sorting by a field of the related AccountSocialRelation record. Set exactly one field in each item. - `id: OrderByEnum` Unique identifier of entity. Must match with Account id. - `isDeleted: OrderByEnum` Specifies if the entity is considered deleted. - `modified: OrderByEnum` Last modification time. - `created: OrderByEnum` Creation time. - `angellistUrl: OrderByEnum` AngelList profile URL of the account. - `crunchbaseUrl: OrderByEnum` Crunchbase profile URL of the account. - `disqusUrl: OrderByEnum` Disqus profile URL of the account. - `facebookUrl: OrderByEnum` Facebook profile URL of the account. - `flickrUrl: OrderByEnum` Flickr profile URL of the account. - `foursquareUrl: OrderByEnum` Foursquare profile URL of the account. - `googlePlusUrl: OrderByEnum` Google+ profile URL of the account. - `gravatarUrl: OrderByEnum` Gravatar profile URL of the account. - `kloutUrl: OrderByEnum` Klout profile URL of the account. - `linkedinUrl: OrderByEnum` LinkedIn profile URL of the account. - `pinterestUrl: OrderByEnum` Pinterest profile URL of the account. - `quoraUrl: OrderByEnum` Quora profile URL of the account. - `redditUrl: OrderByEnum` Reddit profile URL of the account. - `skypeUrl: OrderByEnum` Skype contact URL or username of the account. - `slideshareUrl: OrderByEnum` SlideShare profile URL of the account. - `twitterUrl: OrderByEnum` Twitter (X) profile URL of the account. - `vimeoUrl: OrderByEnum` Vimeo profile URL of the account. - `wordpressUrl: OrderByEnum` WordPress site URL of the account. - `xingUrl: OrderByEnum` XING profile URL of the account. - `yahooUrl: OrderByEnum` Yahoo profile URL of the account. - `yelpUrl: OrderByEnum` Yelp business URL of the account. - `youtubeUrl: OrderByEnum` YouTube channel URL of the account. - `revision: OrderByEnum` Revision when entity was lastly changed. ### ArchiveAccountInput (input) Parameters of the archiveAccount mutation. - `entity: UpdateAccountInput!` Id of the account and optional field values to save together with the archive. - `completeAllRelatedProjects: Boolean!` Completes all unfinished projects of the account. - `archiveAllRelatedLeads: Boolean!` Archives open leads whose primary account is this account. - `archiveAllRelatedOpportunities: Boolean!` Archives open opportunities whose primary account is this account. - `archiveAllRelatedQuotes: Boolean!` Archives open quotes whose primary account is this account. - `archiveAllRelatedContacts: Boolean!` Archives contacts whose primary account is this account. - `completeAllRelatedTasks: Boolean!` Marks all tasks linked to the account as completed. - `completeAllRelatedContactsTasks: Boolean` Marks tasks of contacts whose primary account is this account as completed. - `completeAllRelatedLeadsTasks: Boolean` Marks tasks of leads whose primary account is this account as completed. - `completeAllRelatedOpportunitiesTasks: Boolean` Marks tasks of opportunities whose primary account is this account as completed. - `completeAllRelatedQuotesTasks: Boolean` Marks tasks of quotes whose primary account is this account as completed. - `clientMutationId: String` Optional 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) Parameters of the bulkArchiveAccount mutation. - `bulkFilter: BulkOperationInput!` Accounts to archive: includedIds minus excludedIds. Integrations can leave sessionId empty. - `entity: CreateOrUpdateAccountInput!` Field values saved on every archived account. - `completeAllRelatedProjects: Boolean` Completes all unfinished projects of each account. - `archiveAllRelatedLeads: Boolean` Archives open leads whose primary account is one of the accounts. - `archiveAllRelatedOpportunities: Boolean` Archives open opportunities whose primary account is one of the accounts. - `archiveAllRelatedQuotes: Boolean` Archives open quotes whose primary account is one of the accounts. - `archiveAllRelatedContacts: Boolean` Archives contacts whose primary account is one of the accounts. - `completeAllRelatedTasks: Boolean` Marks all tasks linked to each account as completed. - `completeAllRelatedContactsTasks: Boolean` Marks tasks of the accounts' primary contacts as completed. - `completeAllRelatedLeadsTasks: Boolean` Marks tasks of the accounts' leads as completed. - `completeAllRelatedOpportunitiesTasks: Boolean` Marks tasks of the accounts' opportunities as completed. - `completeAllRelatedQuotesTasks: Boolean` Marks tasks of the accounts' quotes as completed. - `rollbackMethod: RollbackMethod` ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. - `clientMutationId: String` Optional 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) Parameters of the bulkReactivateAccount mutation. - `bulkFilter: BulkOperationInput!` Records to reactivate: includedIds minus excludedIds. Integrations can leave sessionId empty. - `rollbackMethod: RollbackMethod` ROLLBACK_ALL fails the whole request when any item fails; ROLLBACK_FAILED skips only the failed items and reports them in errors. - `clientMutationId: String` Optional 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) Parameters of the changeOwnershipAccount mutation. - `ownerId: ID!` User who becomes the new owner of the account. - `unitId: ID!` Sales unit the account is assigned to. - `keepOwnerAsEditor: Boolean!` 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. - `transferLinkedRecords: Boolean!` 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. - `id: ID!` Identifier of the AccountEntity to perform the action on. - `clientMutationId: String` Optional 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) Parameters of the copyAccount mutation. - `skipCopySuffix: Boolean` When true, the copy keeps the original name without the copy suffix. Defaults to false. - `id: ID!` Identifier of the AccountEntity to perform the action on. - `clientMutationId: String` Optional 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) Field values of a new Account record. - `clientMutationId: String` Optional 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). - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `picture: CreateCloudObjectInput` Profile picture or company logo associated with the account. - `accountClass: AccountClassEnum` Manual classification grade assigned to the account. Used in segmentation and reporting. - `accountTypeId: ID` Id of the account type assigned to this account. - `address: String` Street address of the account. - `city: String` City of the account address. - `comments: String` Free-form notes describing the account. - `country: String` Country of the account address. - `currencyExchangeRatesListId: ID` Id of the currency exchange rate list applied to this account. - `customerTypeId: ID` Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. - `email1: String` Primary email address of the account. Used as default recipient for emails sent from Coevera. - `email2: String` Additional email address. - `email3: String` Additional email address. - `email4: String` Additional email address. - `email5: String` Additional email address. - `homePage: String` Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. - `industryId: ID` Id of the industry classification. - `isArchived: Boolean` True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. - `lastAiAccountHierarchyApplied: DateTime` Time when an AI-suggested account hierarchy was last applied to this account. - `lastAiOrgChartApplied: DateTime` Time when an AI-suggested org chart was last applied to this account. - `name: String!` Name of the entity and its default text representation. - `ownerId: ID!` Id of the account owner. - `parentAccountId: ID` Id of the parent account in the corporate hierarchy. Empty for top-level accounts. - `parentAccountRelationTypeId: ID` Id of the parent-account relationship type. - `phone1: String` Primary phone number of the account. Used as default target for click-to-call. - `phone2: String` Additional phone number. - `phone3: String` Additional phone number. - `phone4: String` Additional phone number. - `phone5: String` Additional phone number. - `pictureId: ID` Id of the profile picture document. - `quickParentAccountName: String` Free-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. - `shareMode: ShareModeEnum` Sharing 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. - `stateProvince: String` State or province of the account address. - `unitId: ID` Id of the sales unit. - `zipCode: String` ZIP or postal code of the account address. - `customFields: JSONString` Custom 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. - `revision: Int` Revision when entity was lastly changed. - `socialMedia: CreateAccountSocialRelationNoIdBackrefInput` Social 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. - `isUnsubscribed: Boolean` If account has any unsubscribed email. - `tags: [CreateTagRelationNoAccountBackrefInput!]` Tag labels applied to this account. - `staticProfiles: [CreateProfileRelationNoAccountBackrefInput!]` Saved view profiles this account currently matches. ### CreateAccountSharingClientRelationNoAccountBackrefInput (input) Field values of a new AccountSharingClientRelation record, created together with the record it belongs to. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `clientId: ID!` Id of the user. - `role: SharingRoleEnum` Access the sharing gives the user on the account: Watcher can view it, Editor can view and edit it. - `revision: Int` Revision when entity was lastly changed. ### CreateAccountSharingSalesUnitRelationNoAccountBackrefInput (input) Field values of a new AccountSharingSalesUnitRelation record, created together with the record it belongs to. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `role: SharingRoleEnum` Access the sharing gives the sales unit on the account: Watcher can view it, Editor can view and edit it. - `unitId: ID!` Id of the sales unit. - `revision: Int` Revision when entity was lastly changed. ### CreateAccountSocialRelationNoIdBackrefInput (input) Field values of a new AccountSocialRelation record, created together with the record it belongs to. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `angellistUrl: String` AngelList profile URL of the account. - `crunchbaseUrl: String` Crunchbase profile URL of the account. - `disqusUrl: String` Disqus profile URL of the account. - `facebookId: String` Facebook page or profile id of the account. - `facebookUrl: String` Facebook profile URL of the account. - `flickrUrl: String` Flickr profile URL of the account. - `foursquareUrl: String` Foursquare profile URL of the account. - `googleId: String` Google business or profile id of the account. - `googlePlusUrl: String` Google+ profile URL of the account. - `gravatarUrl: String` Gravatar profile URL of the account. - `kloutUrl: String` Klout profile URL of the account. - `linkedinId: String` LinkedIn company or profile id of the account. - `linkedinUrl: String` LinkedIn profile URL of the account. - `pinterestUrl: String` Pinterest profile URL of the account. - `quoraUrl: String` Quora profile URL of the account. - `redditUrl: String` Reddit profile URL of the account. - `skypeUrl: String` Skype contact URL or username of the account. - `slideshareUrl: String` SlideShare profile URL of the account. - `twitterId: String` Twitter (X) user id of the account. - `twitterUrl: String` Twitter (X) profile URL of the account. - `vimeoUrl: String` Vimeo profile URL of the account. - `wordpressUrl: String` WordPress site URL of the account. - `xingUrl: String` XING profile URL of the account. - `yahooUrl: String` Yahoo profile URL of the account. - `yelpUrl: String` Yelp business URL of the account. - `youtubeUrl: String` YouTube channel URL of the account. - `revision: Int` Revision when entity was lastly changed. ### CreateOrUpdateAccountInput (input) Field values of an Account record to create, or to update when its id is set. - `clientMutationId: String` Optional 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). - `id: ID` Unique identifier of entity. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `picture: CreateCloudObjectInput` Profile picture or company logo associated with the account. - `accountClass: AccountClassEnum` Manual classification grade assigned to the account. Used in segmentation and reporting. - `accountTypeId: ID` Id of the account type assigned to this account. - `address: String` Street address of the account. - `city: String` City of the account address. - `comments: String` Free-form notes describing the account. - `country: String` Country of the account address. - `currencyExchangeRatesListId: ID` Id of the currency exchange rate list applied to this account. - `customerTypeId: ID` Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. - `email1: String` Primary email address of the account. Used as default recipient for emails sent from Coevera. - `email2: String` Additional email address. - `email3: String` Additional email address. - `email4: String` Additional email address. - `email5: String` Additional email address. - `homePage: String` Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. - `industryId: ID` Id of the industry classification. - `isArchived: Boolean` True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. - `lastAiAccountHierarchyApplied: DateTime` Time when an AI-suggested account hierarchy was last applied to this account. - `lastAiOrgChartApplied: DateTime` Time when an AI-suggested org chart was last applied to this account. - `name: String` Name of the entity and its default text representation. - `ownerId: ID` Id of the account owner. - `parentAccountId: ID` Id of the parent account in the corporate hierarchy. Empty for top-level accounts. - `parentAccountRelationTypeId: ID` Id of the parent-account relationship type. - `phone1: String` Primary phone number of the account. Used as default target for click-to-call. - `phone2: String` Additional phone number. - `phone3: String` Additional phone number. - `phone4: String` Additional phone number. - `phone5: String` Additional phone number. - `pictureId: ID` Id of the profile picture document. - `quickParentAccountName: String` Free-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. - `shareMode: ShareModeEnum` Sharing 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. - `stateProvince: String` State or province of the account address. - `unitId: ID` Id of the sales unit. - `zipCode: String` ZIP or postal code of the account address. - `customFields: JSONString` Custom 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. - `revision: Int` Revision when entity was lastly changed. - `socialMedia: UpdateAccountSocialRelationNoIdBackrefInput` Social 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. - `isUnsubscribed: Boolean` If account has any unsubscribed email. - `tags: [CreateTagRelationNoAccountBackrefInput!]` Tag labels applied to this account. - `staticProfiles: [CreateProfileRelationNoAccountBackrefInput!]` Saved view profiles this account currently matches. ### CreateProfileRelationNoAccountBackrefInput (input) Field values of a new ProfileRelation record, created together with the record it belongs to. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `contactId: ID` Id of the linked contact. - `customEntityId: ID` Id of the linked custom entity record. - `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not pointing to one. - `profileId: ID!` Id of the screen profile. - `projectId: ID` Id of the linked project. - `quoteId: ID` Id of the linked quote. ### CreateTagRelationNoAccountBackrefInput (input) Field values of a new TagRelation record, created together with the record it belongs to. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `appointmentId: ID` Id of the linked appointment. - `contactId: ID` Id of the linked contact. - `customEntityId: ID` Id of the linked custom entity record. - `emailId: ID` Id of the linked email. - `leadId: ID` Id of the linked lead. - `opptyId: ID` Id of the linked opportunity. - `processId: ID` Id of the linked sales process. - `projectId: ID` Id of the linked project. - `quoteId: ID` Id of the linked quote. - `solutionId: ID` Id of the linked solution. - `tagId: ID!` Id of the tag attached to the record. - `taskId: ID` Id of the linked task. - `revision: Int` Revision when entity was lastly changed. ### DeleteAccountInput (input) Id of the Account record to delete. - `clientMutationId: String` Optional 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). - `id: ID!` Unique identifier of entity. ### ManageSharingAccountInput (input) Parameters of the manageSharingAccount mutation. - `shareMode: ShareModeEnum!` 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. - `id: ID!` Identifier of the AccountEntity to perform the action on. - `clientMutationId: String` Optional 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) Parameters of the mergeAccount mutation. - `master: UpdateAccountInput!` Id of the account to keep and the field values it should end up with. - `slaveId: ID!` Id of the duplicate account that is merged into the master and then deleted. - `clientMutationId: String` Optional 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) Sorting by a field of the related ParentAccountRelationType record. Set exactly one field in each item. - `id: OrderByEnum` Unique identifier of entity. - `isDeleted: OrderByEnum` Specifies if the entity is considered deleted. - `modified: OrderByEnum` Last modification time. - `created: OrderByEnum` Creation time. - `childLabel: OrderByEnum` Label shown for the child side of the parent-child account relation (e.g. "Subsidiary" when the parent is a holding company). - `parentLabel: OrderByEnum` Label shown for the parent side of the parent-child account relation (e.g. "Parent company"). - `revision: OrderByEnum` Revision when entity was lastly changed. ### ReactivateAccountInput (input) Parameters of the reactivateAccount mutation. - `id: UUID!` Id of the archived account. - `clientMutationId: String` Optional 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) Parameters of the restoreAccount mutation. - `id: ID!` Identifier of the AccountEntity to perform the action on. - `clientMutationId: String` Optional 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) Id of an Account record and the field values to change. - `clientMutationId: String` Optional 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). - `id: ID!` Unique identifier of entity. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `picture: CreateCloudObjectInput` Profile picture or company logo associated with the account. - `accountClass: AccountClassEnum` Manual classification grade assigned to the account. Used in segmentation and reporting. - `accountTypeId: ID` Id of the account type assigned to this account. - `address: String` Street address of the account. - `city: String` City of the account address. - `comments: String` Free-form notes describing the account. - `country: String` Country of the account address. - `currencyExchangeRatesListId: ID` Id of the currency exchange rate list applied to this account. - `customerTypeId: ID` Id of the customer type (e.g. Lead, Prospect, Customer) that classifies the account. - `email1: String` Primary email address of the account. Used as default recipient for emails sent from Coevera. - `email2: String` Additional email address. - `email3: String` Additional email address. - `email4: String` Additional email address. - `email5: String` Additional email address. - `homePage: String` Website URL of the account. May be auto-filled from the primary email domain when domain extraction is enabled. - `industryId: ID` Id of the industry classification. - `isArchived: Boolean` True when the account has been archived. Archived accounts remain readable but are hidden from active lists and cannot be edited until reactivated. - `lastAiAccountHierarchyApplied: DateTime` Time when an AI-suggested account hierarchy was last applied to this account. - `lastAiOrgChartApplied: DateTime` Time when an AI-suggested org chart was last applied to this account. - `name: String` Name of the entity and its default text representation. - `ownerId: ID` Id of the account owner. - `parentAccountId: ID` Id of the parent account in the corporate hierarchy. Empty for top-level accounts. - `parentAccountRelationTypeId: ID` Id of the parent-account relationship type. - `phone1: String` Primary phone number of the account. Used as default target for click-to-call. - `phone2: String` Additional phone number. - `phone3: String` Additional phone number. - `phone4: String` Additional phone number. - `phone5: String` Additional phone number. - `pictureId: ID` Id of the profile picture document. - `quickParentAccountName: String` Free-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. - `shareMode: ShareModeEnum` Sharing 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. - `stateProvince: String` State or province of the account address. - `unitId: ID` Id of the sales unit. - `zipCode: String` ZIP or postal code of the account address. - `customFields: JSONString` Custom 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. - `revision: Int` Revision when entity was lastly changed. - `socialMedia: UpdateAccountSocialRelationNoIdBackrefInput` Social 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. - `isUnsubscribed: Boolean` If account has any unsubscribed email. - `tags: [CreateTagRelationNoAccountBackrefInput!]` Tag labels applied to this account. - `staticProfiles: [CreateProfileRelationNoAccountBackrefInput!]` Saved view profiles this account currently matches. ### UpdateAccountSocialRelationNoIdBackrefInput (input) Id of an AccountSocialRelation record and the field values to change, updated together with the record it belongs to. - `modified: DateTime` Last modification time. - `created: DateTime` Creation time. - `angellistUrl: String` AngelList profile URL of the account. - `crunchbaseUrl: String` Crunchbase profile URL of the account. - `disqusUrl: String` Disqus profile URL of the account. - `facebookId: String` Facebook page or profile id of the account. - `facebookUrl: String` Facebook profile URL of the account. - `flickrUrl: String` Flickr profile URL of the account. - `foursquareUrl: String` Foursquare profile URL of the account. - `googleId: String` Google business or profile id of the account. - `googlePlusUrl: String` Google+ profile URL of the account. - `gravatarUrl: String` Gravatar profile URL of the account. - `kloutUrl: String` Klout profile URL of the account. - `linkedinId: String` LinkedIn company or profile id of the account. - `linkedinUrl: String` LinkedIn profile URL of the account. - `pinterestUrl: String` Pinterest profile URL of the account. - `quoraUrl: String` Quora profile URL of the account. - `redditUrl: String` Reddit profile URL of the account. - `skypeUrl: String` Skype contact URL or username of the account. - `slideshareUrl: String` SlideShare profile URL of the account. - `twitterId: String` Twitter (X) user id of the account. - `twitterUrl: String` Twitter (X) profile URL of the account. - `vimeoUrl: String` Vimeo profile URL of the account. - `wordpressUrl: String` WordPress site URL of the account. - `xingUrl: String` XING profile URL of the account. - `yahooUrl: String` Yahoo profile URL of the account. - `yelpUrl: String` Yelp business URL of the account. - `youtubeUrl: String` YouTube channel URL of the account. - `revision: Int` Revision when entity was lastly changed. ### ArchiveAccountPayload (object) Result of the archiveAccount mutation. - `result: AccountEntity` The archived account. - `clientMutationId: String` Optional 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 of the bulkArchiveAccount mutation. - `result: BulkUpdateResults!` Ids of the archived accounts and the items that failed. - `clientMutationId: String` Optional 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 of the bulkReactivateAccount mutation. - `result: BulkUpdateResults!` Ids of the reactivated records and the items that failed. - `clientMutationId: String` Optional 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 of the bulkUpdateAccount mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### ChangeOwnershipAccountPayload (object) Result of the changeOwnershipAccount mutation. - `result: AccountEntity` The account with its new owner. - `clientMutationId: String` Optional 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) Result of the convertAccount mutation. - `account: AccountEntity!` The created record. - `clientMutationId: String` Optional 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 of the copyAccount mutation. - `result: AccountEntity` The new account. - `clientMutationId: String` Optional 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) Result of the createAccount mutation. - `account: AccountEntity` The created record. - `clientMutationId: String` Optional 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) Result of the deleteAccount mutation. - `account: AccountEntity` The deleted record. - `clientMutationId: String` Optional 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 of the manageSharingAccount mutation. - `result: AccountEntity` The record with its updated sharing. - `clientMutationId: String` Optional 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 of the mergeAccount mutation. - `result: AccountEntity` The merged master account. - `clientMutationId: String` Optional 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 of the reactivateAccount mutation. - `result: AccountEntity` The reactivated account. - `clientMutationId: String` Optional 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 of the restoreAccount mutation. - `result: AccountEntity` The restored record. - `clientMutationId: String` Optional 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) Result of the updateAccount mutation. - `account: AccountEntity` The updated record. - `clientMutationId: String` Optional 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) New, unsaved account pre-filled with the values of an AI suggestion, with the ids of the fields that were filled in. - `entity: AccountEntity` New account carrying the pre-filled values; it is not saved. - `fieldIds: [UUID!]!` Ids of the fields that were filled in. ### AccountClassEnum (enum) Classification grade of an account. - `NoClass` The account is not classified. - `ClassA` Most valuable accounts (class A). - `ClassB` Second most valuable accounts (class B). - `ClassC` Third most valuable accounts (class C). - `ClassD` Least valuable accounts (class D). ### EntityHealthFieldFilterRule (object) Rule of a health indicator: a condition on a field and the score a record gets when it matches. - `id: UUID!` Unique identifier of the health indicator rule. - `field: String!` Identifier of the field this rule evaluates when computing the health score. - `operator: FieldOperator` Comparison 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. - `description: String!` Human-readable label describing what this health indicator measures. - `score: Int!` -1 for critical, otherwise choose between 0 and 100 ### EntityHealthIndicator (object) Result of one health indicator rule for a record. - `id: ID!` Id of the health indicator rule. - `rule: EntityHealthFieldFilterRule!` Health indicator rule that was evaluated. - `indicator: EntityHealthIndicatorEnum!` Result of the rule for the record. - `value: JSONString` Value of the evaluated field on the record at the time of the calculation. ### EntityHealthIndicatorEnum (enum) Result of one health indicator rule for a record. - `Ok` The record meets the rule. - `Error` The record does not meet the rule and loses its points. - `Critical` The record does not meet a critical rule, which puts it in the critical health category. ### EntityHealthResult (object) Health of a record: its score, its trend and the result of each indicator rule. - `score: Int!` 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. - `trend: EntityHealthTrendEnum!` How the score changed compared with the previous calculation. - `indicators: [EntityHealthIndicator!]!` Result of each health indicator rule, the rules that are not met first. - `lastCalculation: DateTime!` When the health of the record was last calculated. ### EntityHealthTrendEnum (enum) How a record's health score changed compared with the previous calculation. - `Increasing` The score went up. - `Decreasing` The score went down. - `NoChange` The score stayed the same, or there is no earlier score. - `Critical` The score falls into the critical health category. ### FieldFilterRule (object) Filter condition that compares one field with a set of values. - `id: UUID` Identifier of this condition within the filter box. Used to reference the condition from the box formula. - `field: String!` Identifier of the field this condition is evaluated against. - `operator: FieldOperator` Comparison 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) Comparison applied between a field and the supplied values in a filter condition or formatting rule. - `Nop` For checkbox fields only: matches records where the checkbox is checked (or unchecked when the value is false). - `Is` Field equals the value; text comparison ignores case. - `IsNot` Field does not equal the value, including records where the field is empty. - `IsEmpty` Field has no value; no comparison value is needed. - `IsNotEmpty` Field has a value; no comparison value is needed. - `Less` Field is less than the value. - `LessOrEqual` Field is less than or equal to the value. - `More` Field is greater than the value. - `MoreOrEqual` Field is greater than or equal to the value. - `Between` Field lies between the two values, bounds included; an omitted bound leaves that side open. - `BetweenNot` Field lies outside the two values or is empty. - `Contains` Field contains the value as a substring, ignoring case. - `ContainsNot` Field does not contain the value as a substring, or is empty. - `Has` Multi-value field contains all of the listed values. - `HasNot` Multi-value field does not contain all of the listed values, or is empty. - `RelativePeriod` Date field falls within a dynamic period given by a PeriodKind value (for example MonthCurrent), evaluated relative to today. - `RelativePeriodNot` Date field falls outside the given dynamic period. - `In` Field matches at least one of the listed values. - `InNot` Field matches none of the listed values, or is empty. - `StartsWith` Text field starts with the value, ignoring case. - `EndsWith` Text field ends with the value, ignoring case. - `IsActive` For owner fields: the owner is an active user. - `IsNotActive` For owner fields: the owner is a deactivated user. ### FilterFieldRuleInterface (interface) Single filter condition: the field, the comparison operator and the values it is compared with. - `id: UUID` Identifier of this condition within the filter box. Used to reference the condition from the box formula. - `field: String!` Identifier of the field this condition is evaluated against. - `operator: FieldOperator` Comparison 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). Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file. ## Example ```graphql query FirstAccounts { entities { account { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name formattedName modified } } } } } } ``` ```bash 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 FirstAccounts { entities { account { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name formattedName modified } } } } } }"}' ``` ## Examples of each operation Built from the schema and checked against it; replace the placeholders, such as ``, with values from your space. ### getById ```graphql query AccountGetById { entities { account { getById(entityId: "") { id name formattedName modified } } } } ``` ### getByIds ```graphql query AccountGetByIds { entities { account { getByIds(entityIds: [""]) { id name formattedName modified } } } } ``` ### getAll ```graphql query AccountGetAll { entities { account { getAll(limit: 10) { id name formattedName modified } } } } ``` ### getByCriteria ```graphql query AccountGetByCriteria { entities { account { getByCriteria(first: 10) { totalCount edges { node { id name formattedName modified } } pageInfo { hasNextPage endCursor } } } } } ``` ### getChangedFieldsSinceRevision ```graphql query AccountGetChangedFieldsSinceRevision { entities { account { getChangedFieldsSinceRevision(id: "", revision: 10) } } } ``` ### getBySession ```graphql query AccountGetBySession { entities { account { getBySession( includedIds: [""] excludedIds: [""] sessionId: "" first: 10 ) { totalCount edges { node { id name formattedName modified } } pageInfo { hasNextPage endCursor } } } } } ``` ### getByIdFormatted ```graphql query AccountGetByIdFormatted { entities { account { getByIdFormatted(id: "") } } } ``` ### getEligibleParents ```graphql query AccountGetEligibleParents { entities { account { getEligibleParents(accountId: "", limit: 10) { id name formattedName modified } } } } ``` ### getRelatedToContact ```graphql query AccountGetRelatedToContact { entities { account { getRelatedToContact(limit: 10) { id name formattedName modified } } } } ``` ### autoPrefill ```graphql query AccountAutoPrefill { entities { account { autoPrefill(mappingId: "", entityId: "") { id name formattedName modified } } } } ``` ### aiAutoPrefill ```graphql query AccountAiAutoPrefill { entities { account { aiAutoPrefill(actionId: "") { entity { id name formattedName modified } fieldIds } } } } ``` ### changeOwnershipAccount ```graphql mutation ChangeOwnershipAccount { changeOwnershipAccount( input: {ownerId: "", unitId: "", keepOwnerAsEditor: false, transferLinkedRecords: false, id: ""} ) { result { id name formattedName modified } } } ``` ### manageSharingAccount ```graphql mutation ManageSharingAccount { manageSharingAccount(input: {shareMode: Standard, id: ""}) { result { id name formattedName modified } } } ``` ### restoreAccount ```graphql mutation RestoreAccount { restoreAccount(input: {id: ""}) { result { id name formattedName modified } } } ``` ### copyAccount ```graphql mutation CopyAccount { copyAccount(input: {id: ""}) { result { id name formattedName modified } } } ``` ### mergeAccount ```graphql mutation MergeAccount { mergeAccount(input: {master: {id: ""}, slaveId: ""}) { result { id name formattedName modified } } } ``` ### archiveAccount ```graphql mutation ArchiveAccount { archiveAccount( input: {entity: {id: ""}, completeAllRelatedProjects: false, archiveAllRelatedLeads: false, archiveAllRelatedOpportunities: false, archiveAllRelatedQuotes: false, archiveAllRelatedContacts: false, completeAllRelatedTasks: false} ) { result { id name formattedName modified } } } ``` ### reactivateAccount ```graphql mutation ReactivateAccount { reactivateAccount(input: {id: ""}) { result { id name formattedName modified } } } ``` ### createAccount ```graphql mutation CreateAccount { createAccount(input: {name: "Northwind Analytics", ownerId: ""}) { account { id name formattedName modified } } } ``` ### updateAccount ```graphql mutation UpdateAccount { updateAccount(input: {id: ""}) { account { id name formattedName modified } } } ``` ### bulkUpdateAccount ```graphql mutation BulkUpdateAccount { bulkUpdateAccount(input: [{id: ""}]) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } } ``` ### deleteAccount ```graphql mutation DeleteAccount { deleteAccount(input: {id: ""}) { account { id name formattedName modified } } } ``` ### bulkArchiveAccount ```graphql mutation BulkArchiveAccount { bulkArchiveAccount( input: {bulkFilter: {includedIds: [""]}, entity: {id: ""}} ) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } } ``` ### bulkReactivateAccount ```graphql mutation BulkReactivateAccount { bulkReactivateAccount(input: {bulkFilter: {includedIds: [""]}}) { result { created { id } errors { index code message entityId } updated deleted errorsOnDelete { index code message entityId } } } } ``` ### convertAccount ```graphql mutation ConvertAccount { convertAccount( input: {name: "Northwind Analytics", ownerId: ""} sourceEntity: AiAgent sourceEntityId: "" operation: Nothing options: {} ) { account { id name formattedName modified } } } ```