---
title: entities.profile
description: Read profile records with the profile repository, and change them with the profile mutations. Same records as the REST Profiles entity.
canonical: https://developers.coevera.com/reference/graphql/profile/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.profile

Read profile records with the profile repository, and change them with the profile mutations. Same records as the REST Profiles entity.

REST: [Profiles](https://developers.coevera.com/reference/rest/profiles.md).

## Queries

- `getById(entityId: ID!): ProfileEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [ProfileEntity!]!` 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: ProfileFilterInput, orderBy: [ProfileOrderByInput!], includeDeleted: Boolean): [ProfileEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: ProfileFilterInput, orderBy: [ProfileOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): ProfileEntityConnection` 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.
- `getStaticProfilesForAdmin: [DefaultProfileEntity!]!` Returns the built-in default screen profiles of every screen, including one set per custom entity, for administration.
- `getProfilesForAdminByIds(ids: [UUID!]!, includeDeleted: Boolean): [ProfileEntity!]!` Returns the screen profiles with the given ids for administration, regardless of their owner. Built-in default profiles are not included.
- `getProfilesInAdmin(screen: ScreenTypeEnum!, entityApiName: String, before: String, after: String, first: Int, last: Int): ProfileEntityConnection` Returns a page of screen profiles shared with everyone for the given screen, for administration. Built-in default profiles are not included.

## Types

### ProfileEntity (object)

Saved view of an app screen (e.g. leads, accounts or opportunities) with its filter, layout and charts, optionally shared with others.

- `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.
- `owner: ClientEntity` User who owns the screen profile.
- `syncEntity: ReportEntity` Specific record this profile is synchronized to. Set only when syncEnabled is true.
- `entity: ScreenTypeEnum!` Application screen the profile (saved view) belongs to, such as the leads, accounts or opportunities screen. For custom entity screens, entityApiName identifies the custom entity.
- `entityApiName: String` API name of the custom entity this profile applies to. Set only when the profile targets a custom entity screen; otherwise empty.
- `name: String!` Name of the entity and its default text representation.
- `ownerId: ID!` Id of the owning user.
- `settings: JSONString!` Layout and chart configuration of the screen profile, stored as a JSON document. This payload conforms to the `ProfileSettings` JSON Schema: GET /api/v100/rest/schemas/ProfileSettings.json on your region's API host
- `shareMode: ShareModeEnum` Who besides the owner can use the profile: nobody (Private), selected users and sales units (Standard), or all users.
- `syncEnabled: Boolean` When true, changes to the profile are propagated to records linked via ProfileRelation; when false, the profile is detached from the records.
- `syncEntityId: ID` Id of the synchronized record.
- `type: ProfileTypeEnum` Whether the profile lists the records matching its filter (Dynamic) or a fixed list of records added to it explicitly (Static).
- `useLang: Boolean` When true, the profile name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
- `revision: Int` Revision when entity was lastly changed.
- `pipelines: [UUID!]!` For pipeline-screen profiles, ids of the pipelines included in the profile configuration; empty for profiles on other screens.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### ProfileEntityConnection (object)

Paginated list of Profile records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [ProfileEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### ProfileEntityEdge (object)

A Relay edge containing a `ProfileEntity` and its cursor.

- `node: ProfileEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### ProfileFilterInput (input)

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

- `OR: [ProfileFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [ProfileFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: ProfileFilterInput` 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.
- `entity: ScreenTypeEnumFilterInput` Application screen the profile (saved view) belongs to, such as the leads, accounts or opportunities screen. For custom entity screens, entityApiName identifies the custom entity.
- `entityApiName: EntityFilterStringField` API name of the custom entity this profile applies to. Set only when the profile targets a custom entity screen; otherwise empty.
- `name: EntityFilterStringField` Name of the entity and its default text representation.
- `ownerId: EntityFilterStringField` Id of the owning user.
- `shareMode: ShareModeEnumFilterInput` Who besides the owner can use the profile: nobody (Private), selected users and sales units (Standard), or all users.
- `syncEnabled: Boolean` When true, changes to the profile are propagated to records linked via ProfileRelation; when false, the profile is detached from the records.
- `syncEntityId: EntityFilterStringField` Id of the synchronized record.
- `type: ProfileTypeEnumFilterInput` Whether the profile lists the records matching its filter (Dynamic) or a fixed list of records added to it explicitly (Static).
- `useLang: Boolean` When true, the profile name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `owner: ClientFilterInput` User who owns the screen profile. Matches records where a related record meets these conditions.
- `syncEntity: ReportFilterInput` Specific record this profile is synchronized to. Set only when syncEnabled is true. Matches records where a related record meets these conditions.

### ProfileOrderByInput (input)

Sorting of Profile 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.
- `owner: [ClientOrderByNestedInput!]` User who owns the screen profile. Sorts by fields of the related record, listed in order of priority.
- `syncEntity: [ReportOrderByNestedInput!]` Specific record this profile is synchronized to. Set only when syncEnabled is true. Sorts by fields of the related record, listed in order of priority.
- `entity: OrderByEnum` Application screen the profile (saved view) belongs to, such as the leads, accounts or opportunities screen. For custom entity screens, entityApiName identifies the custom entity.
- `entityApiName: OrderByEnum` API name of the custom entity this profile applies to. Set only when the profile targets a custom entity screen; otherwise empty.
- `name: OrderByEnum` Name of the entity and its default text representation.
- `ownerId: OrderByEnum` Id of the owning user.
- `shareMode: OrderByEnum` Who besides the owner can use the profile: nobody (Private), selected users and sales units (Standard), or all users.
- `syncEnabled: OrderByEnum` When true, changes to the profile are propagated to records linked via ProfileRelation; when false, the profile is detached from the records.
- `syncEntityId: OrderByEnum` Id of the synchronized record.
- `useLang: OrderByEnum` When true, the profile name is treated as a translation key and localized in the UI; otherwise the literal name is shown.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### ProfileTypeEnumFilterInput (input)

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

- `eq: [ProfileTypeEnum!]` Matches any of the listed values.
- `NOT: ProfileTypeEnumFilterInput` Matches values that do not meet this condition.

### ScreenTypeEnumFilterInput (input)

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

- `eq: [ScreenTypeEnum!]` Matches any of the listed values.
- `NOT: ScreenTypeEnumFilterInput` Matches values that do not meet this condition.

### DefaultProfileEntity (object)

Built-in default profile of a screen: the predefined view of records the screen offers before users create profiles of their own.

- `id: UUID!` Identifier of the default screen profile.
- `name: String!` Name of the profile; a translation key when `useLang` is true.
- `entity: ScreenTypeEnum!` Screen the profile belongs to.
- `pipelines: [UUID!]!` Pipelines the profile shows; empty when it is not limited to pipelines.
- `useLang: Boolean!` True when `name` is a translation key that is shown localized.
- `entityApiName: String` API name of the custom entity the profile belongs to; empty otherwise.

### ProfileTypeEnum (enum)

Whether a saved view (profile) lists records by filter or holds a fixed set of records.

- `Dynamic` Records are selected by the profile's filter.
- `Static` Static list of records added explicitly.

### ScreenTypeEnum (enum)

Application screen a saved view (profile) belongs to.

- `Pipelinescreen` Opportunities screen (pipeline view of open opportunities).
- `Timelinescreen` Legacy value; no longer used.
- `Archivescreen` Archive of closed (won or lost) opportunities.
- `Leadscreen` Screen listing open leads.
- `Accountscreen` Screen listing accounts.
- `Contactscreen` Screen listing contacts.
- `Activityscreen` Screen listing tasks and appointments.
- `Feedscreen` Legacy value of the original Feed screen; replaced by Feedscreen2.
- `Hrmscreen` Legacy value; no longer used.
- `Auditscreen` Legacy value; no longer used.
- `Navigator` Original Navigator screen.
- `Insightsscreen` Insights area: overview of sales performance.
- `Indicatorsscreen` Insights area: key sales indicators.
- `Conversionsscreen` Insights area: conversion rates between pipeline steps.
- `Lifecyclescreen` Insights area: lifecycle of leads and opportunities.
- `Feedscreen2` Feed screen showing the stream of activities, emails and other updates.
- `ProductScreen` Screen listing products.
- `Projectscreen` Screen listing projects.
- `Forecastscreen` Sales forecast screen.
- `LeadArchivescreen` Archive of lost or qualified leads.
- `TargetScreen` Sales targets screen.
- `Quotescreen` Screen listing open quotes.
- `QuoteArchivescreen` Archive of closed quotes.
- `Approvalscreen` Screen listing approval requests.
- `CustomEntityscreen` Screen listing records of a custom entity; the profile identifies the custom entity.
- `AccountArchivescreen` Archive of archived accounts.
- `ContactArchivescreen` Archive of archived contacts.
- `FeedDetailScreen` Feed tab on a record's detail screen.
- `BetterNavigatorscreen` Current Navigator screen with configurable widgets.
- `FeedEmailscreen` Email view of the Feed screen.
- `FeedEmailDetailScreen` Email feed tab on a record's detail screen.
- `EmailScreen` Screen listing emails.

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