OBJECT
ClientEntity
User of the space; owns records, belongs to sales units and has a user role that determines what they can do.
link GraphQL Schema definition
- type ClientEntity {
- # 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.
- : Boolean!
- # Unique identifier of entity.
- : ID!
- # Specifies if the entity is considered deleted.
- : Boolean
- # Last modification time.
- : DateTime
- # Creation time.
- : DateTime
- # Default sales unit for the user. New records the user creates are assigned to
- # this unit by default.
- : SalesUnitEntity
- # User role assigned to the user. Determines what features and entities the user
- # can access.
- : MasterRightEntity
- # Id of the default sales unit.
- : ID!
- # Email. Readonly information from UserProfile.
- : String!
- # First name. Readonly information from UserProfile.
- : String
- # Timestamp of the user's most recent login or API request.
- : DateTime
- # Last name. Readonly information from UserProfile.
- : String
- # Id of the assigned user role.
- : ID!
- # Middle name. Readonly information from UserProfile.
- : String
- # Phone number. Readonly information from UserProfile.
- : String
- # Picture name. Readonly information from UserProfile.
- : String
- # Job title or position of the user.
- : String
- # Region. Readonly information from UserProfile.
- : String
- # Deprecated time zone offset of the user, copied from the user profile;
- # read-only. Use timezoneName instead.
- : String
- # 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.
- : ClientTypeEnum
- # Revision when entity was lastly changed.
- : Int
- # Id of the identity provider the user signs in with by default. Empty when none
- # is set or it is disabled.
- : Int
- # Id of the user account (login identity) this user belongs to.
- : Int
- # Sales units the user belongs to (as member or manager).
- #
- # Arguments
- # filter: Filter SalesUnit relations by target SalesUnit
- # attributes.
- # filterEdge: Filter SalesUnitClientRelation relations by edge
- # (relation) SalesUnitClientRelation attributes.
- # orderBy: Order SalesUnit relations by target SalesUnit
- # attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : SalesUnitFilterInput,
- : SalesUnitClientRelationFilterInput,
- : [SalesUnitOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): SalesUnitClientRelationEntityConnection
- # Appointments marked as favorite by the user.
- #
- # Arguments
- # filter: Filter Appointment relations by target Appointment
- # attributes.
- # filterEdge: Filter ClientFavorite relations by edge (relation)
- # ClientFavorite attributes.
- # orderBy: Order Appointment relations by target Appointment
- # attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : AppointmentFilterInput,
- : ClientFavoriteFilterInput,
- : [AppointmentOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ClientFavoriteEntityConnection
- # Tasks marked as favorite by the user.
- #
- # Arguments
- # filter: Filter Task relations by target Task attributes.
- # filterEdge: Filter ClientFavorite relations by edge (relation)
- # ClientFavorite attributes.
- # orderBy: Order Task relations by target Task attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : TaskFilterInput,
- : ClientFavoriteFilterInput,
- : [TaskOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ClientFavoriteEntityConnection
- # Accounts marked as favorite by the user.
- #
- # Arguments
- # filter: Filter Account relations by target Account attributes.
- # filterEdge: Filter ClientFavorite relations by edge (relation)
- # ClientFavorite attributes.
- # orderBy: Order Account relations by target Account attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : AccountFilterInput,
- : ClientFavoriteFilterInput,
- : [AccountOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ClientFavoriteEntityConnection
- # Contacts marked as favorite by the user.
- #
- # Arguments
- # filter: Filter Contact relations by target Contact attributes.
- # filterEdge: Filter ClientFavorite relations by edge (relation)
- # ClientFavorite attributes.
- # orderBy: Order Contact relations by target Contact attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : ContactFilterInput,
- : ClientFavoriteFilterInput,
- : [ContactOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ClientFavoriteEntityConnection
- # Screen profiles marked as favorite by the user.
- #
- # Arguments
- # filter: Filter Profile relations by target Profile attributes.
- # filterEdge: Filter ClientFavorite relations by edge (relation)
- # ClientFavorite attributes.
- # orderBy: Order Profile relations by target Profile attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : ProfileFilterInput,
- : ClientFavoriteFilterInput,
- : [ProfileOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ClientFavoriteEntityConnection
- # Reports marked as favorite by the user.
- #
- # Arguments
- # filter: Filter Report relations by target Report attributes.
- # filterEdge: Filter ClientFavorite relations by edge (relation)
- # ClientFavorite attributes.
- # orderBy: Order Report relations by target Report attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : ReportFilterInput,
- : ClientFavoriteFilterInput,
- : [ReportOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ClientFavoriteEntityConnection
- # Leads marked as favorite by the user.
- #
- # Arguments
- # filter: Filter Lead relations by target Lead attributes.
- # filterEdge: Filter ClientFavorite relations by edge (relation)
- # ClientFavorite attributes.
- # orderBy: Order Lead relations by target Lead attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : LeadFilterInput,
- : ClientFavoriteFilterInput,
- : [LeadOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ClientFavoriteEntityConnection
- # Opportunities marked as favorite by the user.
- #
- # Arguments
- # filter: Filter Opportunity relations by target Opportunity
- # attributes.
- # filterEdge: Filter ClientFavorite relations by edge (relation)
- # ClientFavorite attributes.
- # orderBy: Order Opportunity relations by target Opportunity
- # attributes.
- # includeDeleted: Returns deleted target records as well. Default
- # is true.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : OpportunityFilterInput,
- : ClientFavoriteFilterInput,
- : [OpportunityOrderByInput!],
- : Boolean,
- : String,
- : String,
- : Int,
- : Int
- ): ClientFavoriteEntityConnection
- # 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.
- : String
- # Display name of the user, formatted according to the user's name format
- # preference.
- : String
- # Display name of the user (alias of name).
- : String!
- # List of all managed units (with expanded managed trees, includes whole managed
- # unit subtree).
- : [UUID!]!
- # List of all units where a client is member only, not manager.
- : [UUID!]!
- # State of the user's row-level access recalculation: NoRecalculation (up to
- # date), Pending (queued), or InProgress.
- : UserRecalculationStateEnum
- # Permissions the current user has on this record, out of the requested ones.
- #
- # Arguments
- # permissions: Permissions to check; the result lists those the
- # current user has.
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- }
link Require by
- AccountEntityCompany or organization the sales team works with; contacts, leads, opportunities and activities are linked to it.
- AccountKPIEntityRecorded KPI event of an account, such as its creation, archiving or the first and last email sent, used in KPI reports.
- AccountSharingClientRelationEntitySharing of an account with a user, as a watcher or an editor.
- ActivityCommentEntityComment written by a user on a task or an appointment.
- ActivityKPIEntityRecorded KPI event of a task or an appointment, such as its creation or completion, used in KPI reports.
- AppointmentClientInviteesRelationEntityInvitation of a user of the space to an appointment, with their response.
- AppointmentEntityMeeting or call scheduled in the calendar, with its invited users and contacts, linked to the records it concerns.
- AppointmentReminderEntityReminder a user has set for an appointment, notifying them a given time before it starts.
- AppointmentScheduleEntityOnline booking link through which people book appointments with a user in the time slots the user has available.
- ApprovalApproverEntityUser asked to decide an approval request, with their response and comment.
- ApprovalEntityApproval request that an approval process raised for a record, such as a quote or an opportunity, waiting for the decision of its approvers.
- ApprovalProcessEntityApproval rule that raises approval requests for records of an entity when its trigger conditions are met, and defines who approves them.
- CallEntityPhone call logged in the space, linked to the user who made it and to the contact, account, lead or opportunity it concerns.
- ChatConversationEntityConversation of a user with the AI assistant, either general or about a specific record.
- ClientEntityEdgeA Relay edge containing a `ClientEntity` and its cursor.
- ClientExcludedOpptyEntityChoice of a user to exclude an opportunity from their forecast and quota calculations, or to include it again.
- ClientFavoriteEntityRecord or screen profile that a user has marked as a favorite.
- ClientRepositoryRead operations for Client records.
- ClientSettingEntityPersonal setting of a user, stored as a named value.
- ClientStoryReadEntityMark that a user has read an activity, email or memo in their feed, and whether they chose not to follow up on it.
- CloudObjectEntityFile stored in the space, such as a document, image or recording, that can be attached to records.
- CloudObjectTemplateEntityDocument template, such as a Word or Excel file with placeholders, used to generate documents filled with record data.
- ContactEntityPerson the sales team works with, usually linked to one or more accounts, leads and opportunities.
- ContactKPIEntityRecorded KPI event of a contact, such as its creation, archiving or the first and last email sent, used in KPI reports.
- ContactSharingClientRelationEntitySharing of a contact with a user, as a watcher or an editor.
- CreateClientPayloadResult of the createClient mutation.
- CustomEntityEntityRecord of a custom entity, a kind of record the space defines (such as Vehicle or Contract) in addition to the built-in entities.
- CustomEntityRelationDataEntityLink between two records made through a custom relation, such as an account linked to a custom entity record.
- CustomEntitySharingClientRelationEntitySharing of a custom entity record with a user, as a watcher or an editor.
- DeleteClientPayloadResult of the deleteClient mutation.
- EmailContentSharingClientRelationEntitySharing of the body of an email with a user, letting them read its content.
- EmailEntityEmail message sent or received by users of the space, linked to the contacts, accounts and other records it concerns.
- EmailLabelEntityPersonal label a user applies to email conversations to organize their mailbox; labels can be nested.
- EmailLabelRelationEntityEmail label applied to a conversation in a mailbox.
- EmailSequenceActivityLogEntityLog of one run of an email sequence, with when it started and finished and who triggered it.
- EmailSequenceEnrolledEntityRecord enrolled in an email sequence, such as a contact, lead or opportunity, with the run that enrolled it.
- EmailSequenceEntityAutomated series of emails sent step by step to the records enrolled in it, with rules for when to send and when to stop.
- EmailTemplateEntityReusable email whose body can contain placeholders filled with record values; templates are organized in folders and can be shared.
- EmailTemplateSharingClientRelationEntitySharing of an email template with a user, as a watcher or an editor.
- EmailThreadMailboxClientReadStateEntityTime a user last read an email conversation in a mailbox, telling which conversations have unread emails.
- ForecastEntitySales forecast that sums an amount over the opportunities of a pipeline for a period, broken down by levels such as sales units and users.
- FormViewEntityVariant of the form of an account, contact, lead or opportunity type that hides or colors selected fields; owned by a user and can be shared.
- FormViewSharingClientRelationEntitySharing of a form view with a user, as a watcher or an editor.
- ImportMappingMaskEntitySaved mapping of import file columns to fields, reused when importing records of the same entity.
- LeadEntityPotential sale in its early stage that moves through a lead process until it is qualified into an opportunity or lost.
- LeadOpptyKPIEntityKPI event of a lead or opportunity (e.g. created, qualified, won, lost or moved to another step), used in activity reporting.
- LeadOpptySharingClientRelationEntityShare of a lead or opportunity with an individual user, with the access level granted.
- MemoCommentEntityComment a user wrote on a memo.
- MemoEntityInternal message written by a user and linked to records, which other users can comment on.
- MessageSharingClientRelationEntityShare of a message (email or memo) with an individual user.
- NoteEntityNote a user wrote on a record such as an account, contact, lead, opportunity, project or quote.
- OnlineFormTypeEntityOnline form definition: the fields and settings of a web form whose submissions create or update records.
- OpportunityEntityPotential deal with a value and closing date that moves through the steps of a sales pipeline until it is won or lost.
- PhoneEntityPhone number connected to Coevera for calls, text messages or WhatsApp, either personal to a user or shared by the company.
- ProcessActivityLogEntityOne run of an Automatizer process, with its status, timing and the steps it took.
- ProcessEntityAutomatizer process: an automated workflow that runs its actions when its trigger fires (a record event, a schedule or a webhook).
- ProcessScheduledActionEntityAction of an Automatizer process that is waiting to run for a record at a scheduled time.
- ProfileEntitySaved view of an app screen (e.g. leads, accounts or opportunities) with its filter, layout and charts, optionally shared with others.
- ProfileSharingClientRelationEntityShare of a saved view (profile) with an individual user.
- ProjectEntityProject delivered for an account or run internally, with its objectives, activities and progress.
- ProjectKPIEntityKPI event of a project (its completion), used in activity reporting.
- ProjectSharingClientRelationEntityShare of a project with an individual user, with the access level granted.
- QuoteEntityPrice offer for a customer, usually prepared from an opportunity, with product line items; it moves through a quote process.
- QuoteKPIEntityKPI event of a quote (e.g. created, accepted, archived or moved to another step), used in activity reporting.
- QuoteSharingClientRelationEntityShare of a quote with an individual user, with the access level granted.
- ReportEntitySaved report or dashboard with its settings, sharing and delivery schedule.
- ReportScheduleEntitySchedule that emails a report to its recipients at regular intervals.
- ReportSharingClientRelationEntityShare of a report with an individual user, with the access level granted.
- SalesUnitClientRelationEntityMembership of a user in a sales unit, as a member or manager.
- SolutionEntityCanvas that groups related automation tools (Automatizer processes, email sequences, online forms) and tracks their status and activity.
- TagEntityLabel that users attach to records such as accounts, contacts or opportunities to categorize them.
- TargetEntitySales target set for a user or a group of users for a period, measured by a chosen metric.
- TaskEntityTask (e.g. a to-do or a call) owned by a user, with an optional due date, and linked to records.
- TaskReminderEntityReminder a user set to be notified about a task at a given time.
- TaskSharingClientRelationEntityShare of a task with an individual user, with the access level granted.
- UpdateClientPayloadResult of the updateClient mutation.
- WebhookEntityRegistered webhook urls will be called when subscribed events occur with access level corresponding to the Webhook owner. Recipient has to receive the webhook in 10 seconds and respond with HTTP 200 (2XX) status. On failed delivery it will be retried up to 10 times within 24 hours. If the receiving side will respond with HTTP 410 status, the webhook will be disabled. Webhook is also disabled when we receive HTTP timeout on 10th retry and there was no successful delivery in last 5 days.