--- title: entities.profileRelation description: Read profile relation records with the profileRelation repository, and change them with the profile relation mutations. Same records as the REST ProfileRelations entity. canonical: https://developers.coevera.com/reference/graphql/profile-relation/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # entities.profileRelation Read profile relation records with the profileRelation repository, and change them with the profile relation mutations. Same records as the REST ProfileRelations entity. REST: [ProfileRelations](https://developers.coevera.com/reference/rest/profile-relations.md). ## Queries - `getById(entityId: ID!): ProfileRelationEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [ProfileRelationEntity!]!` 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: ProfileRelationFilterInput, orderBy: [ProfileRelationOrderByInput!], includeDeleted: Boolean): [ProfileRelationEntity!]!` Returns the records that match the filter, paged with limit and offset. - `getByCriteria(filter: ProfileRelationFilterInput, orderBy: [ProfileRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): ProfileRelationEntityConnection` 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. ## Mutations - `createProfileRelation(input: CreateProfileRelationInput!, validationLevel: [ValidationLevel!]): CreateProfileRelationPayload` Create one record. - `updateProfileRelation(input: UpdateProfileRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateProfileRelationPayload` Update fields. - `bulkUpdateProfileRelation(input: [CreateOrUpdateProfileRelationInput!]!, deleteInput: [DeleteProfileRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateProfileRelationPayload` Create or update many; per-item results. - `deleteProfileRelation(input: DeleteProfileRelationInput!): DeleteProfileRelationPayload` Soft-delete. ## Types ### ProfileRelationEntity (object) Record added explicitly to a static saved view (profile). - `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 this profile is linked to, when applicable. - `contact: ContactEntity` Contact this profile is linked to, when applicable. - `customEntity: CustomEntityEntity` Custom entity record this profile is linked to, when applicable. - `lead: LeadEntity` Lead this profile is linked to. Set when leadOpptyId resolves to a Lead. - `oppty: OpportunityEntity` Opportunity this profile is linked to. Set when leadOpptyId resolves to an Opportunity. - `profile: ProfileEntity` Screen profile this relation links to a specific record. - `project: ProjectEntity` Project this profile is linked to, when applicable. - `quote: QuoteEntity` Quote this profile is linked to, when applicable. - `accountId: ID` Id of the linked account. - `contactId: ID` Id of the linked contact. - `customEntityId: ID` Id of the linked custom entity record. - `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not pointing to one. - `profileId: ID!` Id of the screen profile. - `projectId: ID` Id of the linked project. - `quoteId: ID` Id of the linked quote. - `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones. ### ProfileRelationEntityConnection (object) Paginated list of ProfileRelation records. - `pageInfo: PageInfo!` Pagination data for this connection. - `edges: [ProfileRelationEntityEdge]!` Contains the nodes in this connection. - `totalCount: Int` Total number of items in the connection. ### ProfileRelationEntityEdge (object) A Relay edge containing a `ProfileRelationEntity` and its cursor. - `node: ProfileRelationEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### ProfileRelationFilterInput (input) Filter conditions for ProfileRelation records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `OR: [ProfileRelationFilterInput!]` Matches records that meet at least one of the listed filters. - `AND: [ProfileRelationFilterInput!]` Matches records that meet all of the listed filters. - `NOT: ProfileRelationFilterInput` 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 linked account. - `contactId: EntityFilterStringField` Id of the linked contact. - `customEntityId: EntityFilterStringField` Id of the linked custom entity record. - `leadOpptyId: EntityFilterStringField` Id of the linked lead or opportunity, or empty when not pointing to one. - `profileId: EntityFilterStringField` Id of the screen profile. - `projectId: EntityFilterStringField` Id of the linked project. - `quoteId: EntityFilterStringField` Id of the linked quote. - `account: AccountFilterInput` Account this profile is linked to, when applicable. Matches records where a related record meets these conditions. - `contact: ContactFilterInput` Contact this profile is linked to, when applicable. Matches records where a related record meets these conditions. - `customEntity: CustomEntityFilterInput` Custom entity record this profile is linked to, when applicable. Matches records where a related record meets these conditions. - `lead: LeadFilterInput` Lead this profile is linked to. Set when leadOpptyId resolves to a Lead. Matches records where a related record meets these conditions. - `oppty: OpportunityFilterInput` Opportunity this profile is linked to. Set when leadOpptyId resolves to an Opportunity. Matches records where a related record meets these conditions. - `profile: ProfileFilterInput` Screen profile this relation links to a specific record. Matches records where a related record meets these conditions. - `project: ProjectFilterInput` Project this profile is linked to, when applicable. Matches records where a related record meets these conditions. - `quote: QuoteFilterInput` Quote this profile is linked to, when applicable. Matches records where a related record meets these conditions. ### ProfileRelationOrderByInput (input) Sorting of ProfileRelation 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 this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. - `contact: [ContactOrderByNestedInput!]` Contact this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. - `customEntity: [CustomEntityOrderByNestedInput!]` Custom entity record this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. - `lead: [LeadOrderByNestedInput!]` Lead this profile is linked to. Set when leadOpptyId resolves to a Lead. Sorts by fields of the related record, listed in order of priority. - `oppty: [OpportunityOrderByNestedInput!]` Opportunity this profile is linked to. Set when leadOpptyId resolves to an Opportunity. Sorts by fields of the related record, listed in order of priority. - `profile: [ProfileOrderByNestedInput!]` Screen profile this relation links to a specific record. Sorts by fields of the related record, listed in order of priority. - `project: [ProjectOrderByNestedInput!]` Project this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. - `quote: [QuoteOrderByNestedInput!]` Quote this profile is linked to, when applicable. Sorts by fields of the related record, listed in order of priority. - `accountId: OrderByEnum` Id of the linked account. - `contactId: OrderByEnum` Id of the linked contact. - `customEntityId: OrderByEnum` Id of the linked custom entity record. - `leadOpptyId: OrderByEnum` Id of the linked lead or opportunity, or empty when not pointing to one. - `profileId: OrderByEnum` Id of the screen profile. - `projectId: OrderByEnum` Id of the linked project. - `quoteId: OrderByEnum` Id of the linked quote. ### CreateOrUpdateProfileRelationInput (input) Field values of a ProfileRelation 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 linked account. - `contactId: ID` Id of the linked contact. - `customEntityId: ID` Id of the linked custom entity record. - `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not pointing to one. - `profileId: ID` Id of the screen profile. - `projectId: ID` Id of the linked project. - `quoteId: ID` Id of the linked quote. ### CreateProfileRelationInput (input) Field values of a new ProfileRelation 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 linked account. - `contactId: ID` Id of the linked contact. - `customEntityId: ID` Id of the linked custom entity record. - `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not pointing to one. - `profileId: ID!` Id of the screen profile. - `projectId: ID` Id of the linked project. - `quoteId: ID` Id of the linked quote. ### DeleteProfileRelationInput (input) Id of the ProfileRelation 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. - `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not pointing to one. ### UpdateProfileRelationInput (input) Id of a ProfileRelation 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 linked account. - `contactId: ID` Id of the linked contact. - `customEntityId: ID` Id of the linked custom entity record. - `leadOpptyId: ID` Id of the linked lead or opportunity, or empty when not pointing to one. - `profileId: ID` Id of the screen profile. - `projectId: ID` Id of the linked project. - `quoteId: ID` Id of the linked quote. ### BulkUpdateProfileRelationPayload (object) Result of the bulkUpdateProfileRelation mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### CreateProfileRelationPayload (object) Result of the createProfileRelation mutation. - `profileRelation: ProfileRelationEntity` 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). ### DeleteProfileRelationPayload (object) Result of the deleteProfileRelation mutation. - `profileRelation: ProfileRelationEntity` 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). ### UpdateProfileRelationPayload (object) Result of the updateProfileRelation mutation. - `profileRelation: ProfileRelationEntity` 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 FirstProfileRelations { entities { profileRelation { 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 FirstProfileRelations { entities { profileRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}' ```