--- title: entities.clientFavorite description: Read client favorite records with the clientFavorite repository, and change them with the client favorite mutations. Same records as the REST ClientFavorites entity. canonical: https://developers.coevera.com/reference/graphql/client-favorite/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # entities.clientFavorite Read client favorite records with the clientFavorite repository, and change them with the client favorite mutations. Same records as the REST ClientFavorites entity. REST: [ClientFavorites](https://developers.coevera.com/reference/rest/client-favorites.md). ## Queries - `getById(entityId: ID!): ClientFavoriteEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [ClientFavoriteEntity!]!` 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: ClientFavoriteFilterInput, orderBy: [ClientFavoriteOrderByInput!], includeDeleted: Boolean): [ClientFavoriteEntity!]!` Returns the records that match the filter, paged with limit and offset. - `getByCriteria(filter: ClientFavoriteFilterInput, orderBy: [ClientFavoriteOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): ClientFavoriteEntityConnection` 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. - `isEntityFavorite(ownerId: UUID, accountId: UUID, activityId: UUID, contactId: UUID, leadOpptyId: UUID, profileId: UUID, reportId: UUID, quoteId: UUID): Boolean!` Returns true when the record is marked as a favorite by the user. Exactly one record id must be given. ## Mutations - `createClientFavorite(input: CreateClientFavoriteInput!, validationLevel: [ValidationLevel!]): CreateClientFavoritePayload` Create one record. - `updateClientFavorite(input: UpdateClientFavoriteInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateClientFavoritePayload` Update fields. - `bulkUpdateClientFavorite(input: [CreateOrUpdateClientFavoriteInput!]!, deleteInput: [DeleteClientFavoriteInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateClientFavoritePayload` Create or update many; per-item results. - `deleteClientFavorite(input: DeleteClientFavoriteInput!): DeleteClientFavoritePayload` Soft-delete. ## Types ### ClientFavoriteEntity (object) Record or screen profile that a user has marked as a favorite. - `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. - `account: AccountEntity` Account marked as favorite, when this favorite points to an account. - `appointment: AppointmentEntity` Appointment marked as favorite. Set when activityId resolves to an Appointment. - `task: TaskEntity` Task marked as favorite. Set when activityId resolves to a Task. - `contact: ContactEntity` Contact marked as favorite, when this favorite points to a contact. - `customEntity: CustomEntityEntity` Custom entity record marked as favorite, when this favorite points to a custom entity. - `email: EmailEntity` Email marked as favorite, when this favorite points to an email. - `lead: LeadEntity` Lead marked as favorite. Set when leadOpptyId resolves to a Lead. - `oppty: OpportunityEntity` Opportunity marked as favorite. Set when leadOpptyId resolves to an Opportunity. - `owner: ClientEntity` User who marked the record as favorite. - `profile: ProfileEntity` Screen profile marked as favorite, when this favorite points to a profile. - `project: ProjectEntity` Project marked as favorite, when this favorite points to a project. - `quote: QuoteEntity` Quote marked as favorite, when this favorite points to a quote. - `report: ReportEntity` Report marked as favorite, when this favorite points to a report. - `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. - `ownerId: ID!` Id of the owning user. - `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. - `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones. ### ClientFavoriteEntityConnection (object) Paginated list of ClientFavorite records. - `pageInfo: PageInfo!` Pagination data for this connection. - `edges: [ClientFavoriteEntityEdge]!` Contains the nodes in this connection. - `totalCount: Int` Total number of items in the connection. ### ClientFavoriteEntityEdge (object) A Relay edge containing a `ClientFavoriteEntity` and its cursor. - `node: ClientFavoriteEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### ClientFavoriteFilterInput (input) Filter conditions for ClientFavorite records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `OR: [ClientFavoriteFilterInput!]` Matches records that meet at least one of the listed filters. - `AND: [ClientFavoriteFilterInput!]` Matches records that meet all of the listed filters. - `NOT: ClientFavoriteFilterInput` 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. - `accountId: EntityFilterStringField` Id of the favorite account. - `activityId: EntityFilterStringField` Id of the favorite appointment or task, or empty when not pointing to an activity. - `contactId: EntityFilterStringField` Id of the favorite contact. - `customEntityId: EntityFilterStringField` Id of the favorite custom entity record. - `emailId: EntityFilterStringField` Id of the favorite email. - `leadOpptyId: EntityFilterStringField` Id of the favorite lead or opportunity, or empty when not pointing to one. - `ownerId: EntityFilterStringField` Id of the owning user. - `profileId: EntityFilterStringField` Id of the favorite screen profile. - `projectId: EntityFilterStringField` Id of the favorite project. - `quoteId: EntityFilterStringField` Id of the favorite quote. - `reportId: EntityFilterStringField` Id of the favorite report. - `revision: EntityFilterNumberField` Revision when entity was lastly changed. - `account: AccountFilterInput` Account marked as favorite, when this favorite points to an account. Matches records where a related record meets these conditions. - `appointment: AppointmentFilterInput` Appointment marked as favorite. Set when activityId resolves to an Appointment. Matches records where a related record meets these conditions. - `task: TaskFilterInput` Task marked as favorite. Set when activityId resolves to a Task. Matches records where a related record meets these conditions. - `contact: ContactFilterInput` Contact marked as favorite, when this favorite points to a contact. Matches records where a related record meets these conditions. - `customEntity: CustomEntityFilterInput` Custom entity record marked as favorite, when this favorite points to a custom entity. Matches records where a related record meets these conditions. - `email: EmailFilterInput` Email marked as favorite, when this favorite points to an email. Matches records where a related record meets these conditions. - `lead: LeadFilterInput` Lead marked as favorite. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. - `oppty: OpportunityFilterInput` Opportunity marked as favorite. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. - `owner: ClientFilterInput` User who marked the record as favorite. Matches records where a related record meets these conditions. - `profile: ProfileFilterInput` Screen profile marked as favorite, when this favorite points to a profile. Matches records where a related record meets these conditions. - `project: ProjectFilterInput` Project marked as favorite, when this favorite points to a project. Matches records where a related record meets these conditions. - `quote: QuoteFilterInput` Quote marked as favorite, when this favorite points to a quote. Matches records where a related record meets these conditions. - `report: ReportFilterInput` Report marked as favorite, when this favorite points to a report. Matches records where a related record meets these conditions. ### ClientFavoriteOrderByInput (input) Sorting of ClientFavorite 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. - `account: [AccountOrderByNestedInput!]` Account marked as favorite, when this favorite points to an account. Sorts by fields of the related record, listed in order of priority. - `appointment: [AppointmentOrderByNestedInput!]` Appointment marked as favorite. Set when activityId resolves to an Appointment. Sorts by fields of the related record, listed in order of priority. - `task: [TaskOrderByNestedInput!]` Task marked as favorite. Set when activityId resolves to a Task. Sorts by fields of the related record, listed in order of priority. - `contact: [ContactOrderByNestedInput!]` Contact marked as favorite, when this favorite points to a contact. Sorts by fields of the related record, listed in order of priority. - `customEntity: [CustomEntityOrderByNestedInput!]` Custom entity record marked as favorite, when this favorite points to a custom entity. Sorts by fields of the related record, listed in order of priority. - `email: [EmailOrderByNestedInput!]` Email marked as favorite, when this favorite points to an email. Sorts by fields of the related record, listed in order of priority. - `lead: [LeadOrderByNestedInput!]` Lead marked as favorite. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. - `oppty: [OpportunityOrderByNestedInput!]` Opportunity marked as favorite. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. - `owner: [ClientOrderByNestedInput!]` User who marked the record as favorite. Sorts by fields of the related record, listed in order of priority. - `profile: [ProfileOrderByNestedInput!]` Screen profile marked as favorite, when this favorite points to a profile. Sorts by fields of the related record, listed in order of priority. - `project: [ProjectOrderByNestedInput!]` Project marked as favorite, when this favorite points to a project. Sorts by fields of the related record, listed in order of priority. - `quote: [QuoteOrderByNestedInput!]` Quote marked as favorite, when this favorite points to a quote. Sorts by fields of the related record, listed in order of priority. - `report: [ReportOrderByNestedInput!]` Report marked as favorite, when this favorite points to a report. Sorts by fields of the related record, listed in order of priority. - `accountId: OrderByEnum` Id of the favorite account. - `activityId: OrderByEnum` Id of the favorite appointment or task, or empty when not pointing to an activity. - `contactId: OrderByEnum` Id of the favorite contact. - `customEntityId: OrderByEnum` Id of the favorite custom entity record. - `emailId: OrderByEnum` Id of the favorite email. - `leadOpptyId: OrderByEnum` Id of the favorite lead or opportunity, or empty when not pointing to one. - `ownerId: OrderByEnum` Id of the owning user. - `profileId: OrderByEnum` Id of the favorite screen profile. - `projectId: OrderByEnum` Id of the favorite project. - `quoteId: OrderByEnum` Id of the favorite quote. - `reportId: OrderByEnum` Id of the favorite report. - `revision: OrderByEnum` Revision when entity was lastly changed. ### CreateClientFavoriteInput (input) Field values of a new ClientFavorite 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. - `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. - `ownerId: ID!` Id of the owning user. - `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. ### CreateOrUpdateClientFavoriteInput (input) Field values of a ClientFavorite 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. - `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. - `ownerId: ID` Id of the owning user. - `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. ### DeleteClientFavoriteInput (input) Id of the ClientFavorite 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. - `activityId: ID` Id of the favorite appointment or task, or empty when not pointing to an activity. - `leadOpptyId: ID` Id of the favorite lead or opportunity, or empty when not pointing to one. ### UpdateClientFavoriteInput (input) Id of a ClientFavorite 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. - `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. - `ownerId: ID` Id of the owning user. - `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. ### BulkUpdateClientFavoritePayload (object) Result of the bulkUpdateClientFavorite mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### CreateClientFavoritePayload (object) Result of the createClientFavorite mutation. - `clientFavorite: ClientFavoriteEntity` 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). ### DeleteClientFavoritePayload (object) Result of the deleteClientFavorite mutation. - `clientFavorite: ClientFavoriteEntity` 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). ### UpdateClientFavoritePayload (object) Result of the updateClientFavorite mutation. - `clientFavorite: ClientFavoriteEntity` 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). 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 FirstClientFavorites { entities { clientFavorite { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id 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 FirstClientFavorites { entities { clientFavorite { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}' ```