GraphQL Repositoriesclient

`entities.client`

Read client records with the client repository, and change them with the client mutations. Same records as the REST Clients entity.

13 queries
4 mutations
REST: Clients

Example: first three client recordsGraphQLcURL

query FirstClients {
  entities {
    client {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { 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 FirstClients { entities { client { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name formattedName modified } } } } } }"}'

Queries

Fields of entities { client { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	ClientEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ClientEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ClientFilterInput, orderBy: [ClientOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ClientEntity!]!
QUERY	`getByCriteria`(filter: ClientFilterInput, orderBy: [ClientOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ClientEntityConnection
QUERY	`getChangedFieldsSinceRevision`(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!]!
QUERY	`clientEmailsInSubscription` Returns the email addresses of all users in every space of the subscription the current space belongs to, sorted alphabetically.	[String!]!
QUERY	`getEntitySyncSettings`(name: String!) Returns the current user's synchronization setting with the given name, or null when it does not exist.	EntitySyncSettings
QUERY	`getEntitySyncSettingStatus`(name: String!) Returns the space-wide synchronization status entry with the given name, or null when it does not exist. Only names ending with "_status" are resolved.	EntitySyncSettings
QUERY	`getContactMappings`(serviceType: ServiceMappingType!, flagToDelete: Boolean!, flagOldFormat: Int, foreignIds: [String!]) Returns the current user's links between Coevera contacts and contacts in an external service (Exchange, Office 365 or Google) used by contact synchronization.	[EntityMapping!]!
QUERY	`getTaskMappings`(serviceType: ServiceMappingType!, flagToDelete: Boolean!, flagOldFormat: Int, foreignIds: [String!]) Returns the current user's links between Coevera tasks and tasks in an external service (Exchange, Office 365 or Google) used by task synchronization.	[EntityMapping!]!
QUERY	`getEventMappings`(serviceType: ServiceMappingType!, flagToDelete: Boolean!, flagOldFormat: Int, foreignIds: [String!]) Returns the current user's links between Coevera appointments and events in an external service (Exchange, Office 365 or Google) used by calendar synchronization.	[EntityMapping!]!
QUERY	`getByEmail`(email: String!) Returns the space user with the given email address, or null when there is none. The address is compared case-insensitively.	ClientEntity
QUERY	`getSupportUsers`(invited: Boolean) Returns the support staff who can be invited to the space: customer support users and users of the subscription's partner.	[SupportUser!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createClient`(input: CreateClientInput!, validationLevel: [ValidationLevel!])	Create one record	CreateClientPayload
MUTATION	`updateClient`(input: UpdateClientInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateClientPayload
MUTATION	`bulkUpdateClient`(input: [CreateOrUpdateClientInput!]!, deleteInput: [DeleteClientInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateClientPayload
MUTATION	`deleteClient`(input: DeleteClientInput!)	Soft-delete	DeleteClientPayload

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.

ClientEntity object 39 fields: isDeleteProtected, id, isDeleted, …

User of the space; owns records, belongs to sales units and has a user role that determines what they can do.

Field	Type	Description
`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.
`defaultUnit`	SalesUnitEntity	Default sales unit for the user. New records the user creates are assigned to this unit by default.
`masterRight`	MasterRightEntity	User role assigned to the user. Determines what features and entities the user can access.
`defaultUnitId`	ID!	Id of the default sales unit.
`email`	String!	Email. Readonly information from UserProfile.
`firstName`	String	First name. Readonly information from UserProfile.
`lastActive`	DateTime	Timestamp of the user's most recent login or API request.
`lastName`	String	Last name. Readonly information from UserProfile.
`masterRightId`	ID!	Id of the assigned user role.
`middleName`	String	Middle name. Readonly information from UserProfile.
`phone`	String	Phone number. Readonly information from UserProfile.
`pictureUrl`	String	Picture name. Readonly information from UserProfile.
`position`	String	Job title or position of the user.
`region`	String	Region. Readonly information from UserProfile.
`timezone`	String	Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead.
`type`	ClientTypeEnum	Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person.
`revision`	Int	Revision when entity was lastly changed.
`defaultIdp`	Int	Id of the identity provider the user signs in with by default. Empty when none is set or it is disabled.
`userProfileId`	Int	Id of the user account (login identity) this user belongs to.
`unitMembership`	SalesUnitClientRelationEntityConnection (8 args)	Sales units the user belongs to (as member or manager).
`appointmentFavorite`	ClientFavoriteEntityConnection (8 args)	Appointments marked as favorite by the user.
`taskFavorite`	ClientFavoriteEntityConnection (8 args)	Tasks marked as favorite by the user.
`accountFavorite`	ClientFavoriteEntityConnection (8 args)	Accounts marked as favorite by the user.
`contactFavorite`	ClientFavoriteEntityConnection (8 args)	Contacts marked as favorite by the user.
`profileFavorite`	ClientFavoriteEntityConnection (8 args)	Screen profiles marked as favorite by the user.
`reportFavorite`	ClientFavoriteEntityConnection (8 args)	Reports marked as favorite by the user.
`leadFavorite`	ClientFavoriteEntityConnection (8 args)	Leads marked as favorite by the user.
`opportunityFavorite`	ClientFavoriteEntityConnection (8 args)	Opportunities marked as favorite by the user.
`timezoneName`	String	IANA time zone name of the user (e.g. Europe/Prague), or empty when the time zone is set automatically from the user's operating system. Read-only.
`name`	String	Display name of the user, formatted according to the user's name format preference.
`formattedName`	String!	Display name of the user (alias of name).
`unitManagerIds`	[UUID!]!	List of all managed units (with expanded managed trees, includes whole managed unit subtree).
`unitMemberIds`	[UUID!]!	List of all units where a client is member only, not manager.
`userRecalculationState`	UserRecalculationStateEnum	State of the user's row-level access recalculation: NoRecalculation (up to date), Pending (queued), or InProgress.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

ClientEntityConnection object pageInfo: PageInfo!, edges: [ClientEntityEdge]!, totalCount: Int

Paginated list of Client records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[ClientEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

ClientEntityEdge object node: ClientEntity, cursor: String!

A Relay edge containing a ClientEntity and its cursor.

Field	Type	Description
`node`	ClientEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

ClientFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

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

Input field	Type	Description
`OR`	[ClientFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ClientFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ClientFilterInput	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.
`defaultUnitId`	EntityFilterStringField	Id of the default sales unit.
`email`	EntityFilterStringField	Email. Readonly information from UserProfile.
`firstName`	EntityFilterStringField	First name. Readonly information from UserProfile.
`lastActive`	EntityFilterDateTimeField	Timestamp of the user's most recent login or API request.
`lastName`	EntityFilterStringField	Last name. Readonly information from UserProfile.
`masterRightId`	EntityFilterStringField	Id of the assigned user role.
`middleName`	EntityFilterStringField	Middle name. Readonly information from UserProfile.
`phone`	EntityFilterStringField	Phone number. Readonly information from UserProfile.
`pictureUrl`	EntityFilterStringField	Picture name. Readonly information from UserProfile.
`position`	EntityFilterStringField	Job title or position of the user.
`region`	EntityFilterStringField	Region. Readonly information from UserProfile.
`timezone`	EntityFilterStringField	Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead.
`type`	ClientTypeEnumFilterInput	Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`name`	String	Display name of the user, formatted according to the user's name format preference.
`defaultUnit`	SalesUnitFilterInput	Default sales unit for the user. New records the user creates are assigned to this unit by default. Matches records where a related record meets these conditions.
`masterRight`	MasterRightFilterInput	User role assigned to the user. Determines what features and entities the user can access. Matches records where a related record meets these conditions.
`unitMembership`	SalesUnitClientRelationFilterInput	Sales units the user belongs to (as member or manager). Matches records where a related record meets these conditions.
`appointmentFavorite`	ClientFavoriteFilterInput	Appointments marked as favorite by the user. Matches records where a related record meets these conditions.
`taskFavorite`	ClientFavoriteFilterInput	Tasks marked as favorite by the user. Matches records where a related record meets these conditions.
`accountFavorite`	ClientFavoriteFilterInput	Accounts marked as favorite by the user. Matches records where a related record meets these conditions.
`contactFavorite`	ClientFavoriteFilterInput	Contacts marked as favorite by the user. Matches records where a related record meets these conditions.
`profileFavorite`	ClientFavoriteFilterInput	Screen profiles marked as favorite by the user. Matches records where a related record meets these conditions.
`reportFavorite`	ClientFavoriteFilterInput	Reports marked as favorite by the user. Matches records where a related record meets these conditions.
`leadFavorite`	ClientFavoriteFilterInput	Leads marked as favorite by the user. Matches records where a related record meets these conditions.
`opportunityFavorite`	ClientFavoriteFilterInput	Opportunities marked as favorite by the user. Matches records where a related record meets these conditions.

ClientOrderByInput input Asc or Desc per field

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

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`defaultUnit`	[SalesUnitOrderByNestedInput!]	Default sales unit for the user. New records the user creates are assigned to this unit by default. Sorts by fields of the related record, listed in order of priority.
`masterRight`	[MasterRightOrderByNestedInput!]	User role assigned to the user. Determines what features and entities the user can access. Sorts by fields of the related record, listed in order of priority.
`defaultUnitId`	OrderByEnum	Id of the default sales unit.
`email`	OrderByEnum	Email. Readonly information from UserProfile.
`firstName`	OrderByEnum	First name. Readonly information from UserProfile.
`lastActive`	OrderByEnum	Timestamp of the user's most recent login or API request.
`lastName`	OrderByEnum	Last name. Readonly information from UserProfile.
`masterRightId`	OrderByEnum	Id of the assigned user role.
`middleName`	OrderByEnum	Middle name. Readonly information from UserProfile.
`phone`	OrderByEnum	Phone number. Readonly information from UserProfile.
`pictureUrl`	OrderByEnum	Picture name. Readonly information from UserProfile.
`position`	OrderByEnum	Job title or position of the user.
`region`	OrderByEnum	Region. Readonly information from UserProfile.
`timezone`	OrderByEnum	Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead.
`revision`	OrderByEnum	Revision when entity was lastly changed.
`name`	OrderByEnum	Display name of the user, formatted according to the user's name format preference.

ClientTypeEnumFilterInput input eq: [ClientTypeEnum!], NOT: ClientTypeEnumFilterInput

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

Input field	Type	Description
`eq`	[ClientTypeEnum!]	Matches any of the listed values.
`NOT`	ClientTypeEnumFilterInput	Matches values that do not meet this condition.

CreateClientFavoriteNoOwnerBackrefInput input 13 fields: modified, created, accountId, …

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

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`accountId`	ID	Id of the favorite account.
`activityId`	ID	Id of the favorite appointment or task, or empty when not pointing to an activity.
`contactId`	ID	Id of the favorite contact.
`customEntityId`	ID	Id of the favorite custom entity record.
`emailId`	ID	Id of the favorite email.
`leadOpptyId`	ID	Id of the favorite lead or opportunity, or empty when not pointing to one.
`profileId`	ID	Id of the favorite screen profile.
`projectId`	ID	Id of the favorite project.
`quoteId`	ID	Id of the favorite quote.
`reportId`	ID	Id of the favorite report.
`revision`	Int	Revision when entity was lastly changed.

CreateClientInput input 25 fields: clientMutationId, modified, created, …

Field values of a new Client record.

Input field	Type	Description
`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.
`defaultUnitId`	ID!	Id of the default sales unit.
`email`	String!	Email. Readonly information from UserProfile.
`firstName`	String	First name. Readonly information from UserProfile.
`lastActive`	DateTime	Timestamp of the user's most recent login or API request.
`lastName`	String	Last name. Readonly information from UserProfile.
`masterRightId`	ID!	Id of the assigned user role.
`middleName`	String	Middle name. Readonly information from UserProfile.
`phone`	String	Phone number. Readonly information from UserProfile.
`position`	String	Job title or position of the user.
`region`	String	Region. Readonly information from UserProfile.
`timezone`	String	Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead.
`type`	ClientTypeEnum	Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person.
`revision`	Int	Revision when entity was lastly changed.
`unitMembership`	[CreateSalesUnitClientRelationNoClientBackrefInput!]!	Sales units the user belongs to (as member or manager).
`appointmentFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Appointments marked as favorite by the user.
`taskFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Tasks marked as favorite by the user.
`accountFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Accounts marked as favorite by the user.
`contactFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Contacts marked as favorite by the user.
`profileFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Screen profiles marked as favorite by the user.
`reportFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Reports marked as favorite by the user.
`leadFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Leads marked as favorite by the user.
`opportunityFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Opportunities marked as favorite by the user.

CreateOrUpdateClientInput input 26 fields: clientMutationId, id, modified, …

Field values of a Client record to create, or to update when its id is set.

Input field	Type	Description
`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.
`defaultUnitId`	ID	Id of the default sales unit.
`email`	String	Email. Readonly information from UserProfile.
`firstName`	String	First name. Readonly information from UserProfile.
`lastActive`	DateTime	Timestamp of the user's most recent login or API request.
`lastName`	String	Last name. Readonly information from UserProfile.
`masterRightId`	ID	Id of the assigned user role.
`middleName`	String	Middle name. Readonly information from UserProfile.
`phone`	String	Phone number. Readonly information from UserProfile.
`position`	String	Job title or position of the user.
`region`	String	Region. Readonly information from UserProfile.
`timezone`	String	Deprecated time zone offset of the user, copied from the user profile; read-only. Use timezoneName instead.
`type`	ClientTypeEnum	Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person.
`revision`	Int	Revision when entity was lastly changed.
`unitMembership`	[CreateSalesUnitClientRelationNoClientBackrefInput!]	Sales units the user belongs to (as member or manager).
`appointmentFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Appointments marked as favorite by the user.
`taskFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Tasks marked as favorite by the user.
`accountFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Accounts marked as favorite by the user.
`contactFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Contacts marked as favorite by the user.
`profileFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Screen profiles marked as favorite by the user.
`reportFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Reports marked as favorite by the user.
`leadFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Leads marked as favorite by the user.
`opportunityFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Opportunities marked as favorite by the user.

CreateSalesUnitClientRelationNoClientBackrefInput input 5 fields: modified, created, unitId, …

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

Input field	Type	Description
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`unitId`	ID!	Id of the sales unit.
`unitRole`	UnitRoleEnum	Role of the user in the sales unit: Member, or Manager, which also covers all subunits of the unit.
`revision`	Int	Revision when entity was lastly changed.

DeleteClientInput input clientMutationId: String, id: ID!

Id of the Client record to delete.

Input field	Type	Description
`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.

UpdateClientInput input 18 fields: clientMutationId, id, modified, …

Id of a Client record and the field values to change.

Input field	Type	Description
`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.
`defaultUnitId`	ID	Id of the default sales unit.
`masterRightId`	ID	Id of the assigned user role.
`position`	String	Job title or position of the user.
`type`	ClientTypeEnum	Kind of user: a regular Customer user, a Coevera Support user, or a Placeholder demo user that becomes a Customer when reassigned to a real person.
`revision`	Int	Revision when entity was lastly changed.
`unitMembership`	[CreateSalesUnitClientRelationNoClientBackrefInput!]	Sales units the user belongs to (as member or manager).
`appointmentFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Appointments marked as favorite by the user.
`taskFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Tasks marked as favorite by the user.
`accountFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Accounts marked as favorite by the user.
`contactFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Contacts marked as favorite by the user.
`profileFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Screen profiles marked as favorite by the user.
`reportFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Reports marked as favorite by the user.
`leadFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Leads marked as favorite by the user.
`opportunityFavorite`	[CreateClientFavoriteNoOwnerBackrefInput!]	Opportunities marked as favorite by the user.

BulkUpdateClientPayload object result: BulkUpdateResults!

Result of the bulkUpdateClient mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateClientPayload object client: ClientEntity, clientMutationId: String

Result of the createClient mutation.

Field	Type	Description
`client`	ClientEntity	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).

DeleteClientPayload object client: ClientEntity, clientMutationId: String

Result of the deleteClient mutation.

Field	Type	Description
`client`	ClientEntity	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).

UpdateClientPayload object client: ClientEntity, clientMutationId: String

Result of the updateClient mutation.

Field	Type	Description
`client`	ClientEntity	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).

ApiErrorBase interface code: Int!, name: String!, message: String

Error returned for a failed operation, with its code, name and message.

Field	Type	Description
`code`	Int!	Numeric error code.
`name`	String!	Name of the error code, for example ERROR_FIELD_VALIDATION.
`message`	String	Human-readable description of the error.

BulkErrorResult object 5 fields: index, code, message, …

An item of a bulk operation that failed.

Field	Type	Description
`index`	Int!	Position of the failed item, starting at 0.
`code`	Int!	Numeric error code.
`message`	String!	Error message.
`entityId`	ID	Might be null on create.
`apiError`	EntityValidationError	Validation details when the item failed validation.

ClientTypeEnum enum Customer, Support, Placeholder

Kind of user in the space.

Value	Description
`Customer`	Regular user of the space.
`Support`	Coevera customer-support user with access to the space.
`Placeholder`	Placeholder user in a demo space that has not been assigned to a real person yet.

EntityMapping object 6 fields: pipelinerEntityId, googleEntityId, exchangeEntityId, …

Link between a Coevera record of the current user and its copy in Google, Exchange or Office 365, kept by synchronization.

Field	Type	Description
`pipelinerEntityId`	UUID	Id of the Coevera record.
`googleEntityId`	String	Id of the linked record in Google; null when not linked there.
`exchangeEntityId`	String	Id of the linked record in Exchange; null when not linked there.
`o365EntityId`	String	Id of the linked record in Office 365; null when not linked there.
`flagToDelete`	Boolean	True when the link is flagged for deletion, so the synchronization removes the copy in the external service, e.g. after the record changed owner.
`error`	BulkErrorResult	Error reported for this link; always null in mapping query results.

EntitySyncSettings object name: String, value: String, created: DateTime, modified: DateTime

Synchronization setting of the current user, as a name and a value.

Field	Type	Description
`name`	String	Name of the setting.
`value`	String	Value of the setting, as a string.
`created`	DateTime	When the setting was first stored.
`modified`	DateTime	When the setting was last changed.

EntityValidationError object 9 fields: code, name, message, …

Error returned when a record fails validation, with the errors of its fields and step checklist items.

Field	Type	Description
`code`	Int!	Numeric error code.
`name`	String!	Name of the error code, for example ERROR_FIELD_VALIDATION.
`message`	String	Human-readable description of the error.
`entityId`	UUID	Id of the record that failed validation.
`entityIndex`	Int	Position of the record, starting at 0, in the relation of its parent record; set when the record was saved as part of another record.
`entityName`	String	Entity of the record, for example Account.
`entityErrors`	[FieldError]	Errors of the record that do not belong to a single field.
`fieldErrors`	[FieldError]	Errors of the record, per field.
`stepChecklistErrors`	[StepChecklistError]	Step checklist items of the record that are not completed or not valid.

FieldError object 6 fields: code, name, message, …

Validation error of one field of a record, or of the record as a whole.

Field	Type	Description
`code`	Int!	Numeric error code.
`name`	String!	Name of the error code, for example ERROR_FIELD_VALIDATION.
`message`	String	Human-readable description of the error.
`fieldName`	String	Name of the field the error relates to.
`fieldId`	UUID	Id of the field the error relates to.
`errors`	[FieldError]	The individual errors of the field.

ServiceMappingType enum Exchange, Google, O365

External calendar, contacts or task service whose synchronization mapping is requested.

Value	Description
`Exchange`	Microsoft Exchange.
`Google`	Google.
`O365`	Microsoft 365.

StepChecklistError object code: Int!, name: String!, message: String, stepChecklistId: UUID!

Error for a step checklist item of a record that is not completed or not valid.

Field	Type	Description
`code`	Int!	Numeric error code.
`name`	String!	Name of the error code, for example ERROR_FIELD_VALIDATION.
`message`	String	Human-readable description of the error.
`stepChecklistId`	UUID!	Id of the step checklist item that is not completed or not valid.

SupportUser object pictureUrl: String, name: String!, email: String!, invited: Boolean!

Customer support or partner user who can be invited into the space to help its users.

Field	Type	Description
`pictureUrl`	String	URL of the profile picture of the support user; empty when none is set.
`name`	String!	Full name of the support user.
`email`	String!	Email address of the support user.
`invited`	Boolean!	True when the support user is already a member of the space.

UserRecalculationStateEnum enum NoRecalculation, InProgress, Pending

State of the recalculation of a user's record access.

Value	Description
`NoRecalculation`	The user's access is up to date.
`InProgress`	Recalculation is running.
`Pending`	Recalculation is queued.