OBJECT
ClientEntity
link GraphQL Schema definition
- type ClientEntity {
- # Tells if the entity instance is protected against delete (Entities that need to
- # be present in the system at any time). Delete action still may fail if entity is
- # deletable, due some other additional validations.
- : 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
- # Timezone offset (DEPRECATED)Readonly information from UserProfile.
- : String
- # Field whose values are strictly defined with an enumeration of values.
- : ClientTypeEnum
- # Revision when entity was lastly changed.
- : Int
- # default_idp retrieved from user, if enabled [HEAVY]
- : Int
- # ID of the associated user account [HEAVY]
- : 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 timezone name from UserProfile
- : 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
- # Checks which permissions current user has on concrete entity instance.
- #
- # Arguments
- # permissions: [Not documented]
- (: [EntityPermsEnum!]!): [EntityPermsEnum!]!
- }
link Require by
- AccountEntitynull
- AccountKPIEntitynull
- AccountSharingClientRelationEntitynull
- ActivityCommentEntitynull
- ActivityKPIEntitynull
- AppointmentClientInviteesRelationEntitynull
- AppointmentEntitynull
- AppointmentReminderEntitynull
- AppointmentScheduleEntitynull
- ApprovalApproverEntitynull
- ApprovalEntitynull
- ApprovalProcessEntitynull
- CallEntitynull
- ChatConversationEntitynull
- ClientEntityEdgeA Relay edge containing a `ClientEntity` and its cursor.
- ClientExcludedOpptyEntitynull
- ClientFavoriteEntitynull
- ClientRepositorynull
- ClientSettingEntitynull
- ClientStoryReadEntitynull
- CloudObjectEntitynull
- CloudObjectTemplateEntitynull
- ContactEntitynull
- ContactKPIEntitynull
- ContactSharingClientRelationEntitynull
- CreateClientPayloadnull
- CustomEntityEntitynull
- CustomEntityRelationDataEntitynull
- CustomEntitySharingClientRelationEntitynull
- DeleteClientPayloadnull
- EmailContentSharingClientRelationEntitynull
- EmailEntitynull
- EmailSequenceActivityLogEntitynull
- EmailSequenceEnrolledEntitynull
- EmailSequenceEntitynull
- EmailTemplateEntitynull
- EmailTemplateSharingClientRelationEntitynull
- ForecastEntitynull
- FormViewEntitynull
- FormViewSharingClientRelationEntitynull
- ImportMappingMaskEntitynull
- LeadEntitynull
- LeadOpptyKPIEntitynull
- LeadOpptySharingClientRelationEntitynull
- MemoCommentEntitynull
- MemoEntitynull
- MessageSharingClientRelationEntitynull
- NoteEntitynull
- OnlineFormTypeEntitynull
- OpportunityEntitynull
- PhoneEntitynull
- ProcessActivityLogEntitynull
- ProcessEntitynull
- ProcessScheduledActionEntitynull
- ProfileEntitynull
- ProfileSharingClientRelationEntitynull
- ProjectEntitynull
- ProjectKPIEntitynull
- ProjectSharingClientRelationEntitynull
- QuoteEntitynull
- QuoteKPIEntitynull
- QuoteSharingClientRelationEntitynull
- ReportEntitynull
- ReportScheduleEntitynull
- ReportSharingClientRelationEntitynull
- SalesUnitClientRelationEntitynull
- TagEntitynull
- TargetEntitynull
- TaskEntitynull
- TaskReminderEntitynull
- TaskSharingClientRelationEntitynull
- UpdateClientPayloadnull
- 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.