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

# entities.leadOpptySharingClientRelation

Read lead oppty sharing client relation records with the leadOpptySharingClientRelation repository, and change them with the lead oppty sharing client relation mutations. Same records as the REST LeadOpptySharingClientRelations entity.

REST: [LeadOpptySharingClientRelations](https://developers.coevera.com/reference/rest/lead-oppty-sharing-client-relations.md).

## Queries

- `getById(entityId: ID!): LeadOpptySharingClientRelationEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [LeadOpptySharingClientRelationEntity!]!` 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: LeadOpptySharingClientRelationFilterInput, orderBy: [LeadOpptySharingClientRelationOrderByInput!], includeDeleted: Boolean): [LeadOpptySharingClientRelationEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: LeadOpptySharingClientRelationFilterInput, orderBy: [LeadOpptySharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): LeadOpptySharingClientRelationEntityConnection` 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

- `createLeadOpptySharingClientRelation(input: CreateLeadOpptySharingClientRelationInput!, validationLevel: [ValidationLevel!]): CreateLeadOpptySharingClientRelationPayload` Create one record.
- `updateLeadOpptySharingClientRelation(input: UpdateLeadOpptySharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateLeadOpptySharingClientRelationPayload` Update fields.
- `bulkUpdateLeadOpptySharingClientRelation(input: [CreateOrUpdateLeadOpptySharingClientRelationInput!]!, deleteInput: [DeleteLeadOpptySharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateLeadOpptySharingClientRelationPayload` Create or update many; per-item results.
- `deleteLeadOpptySharingClientRelation(input: DeleteLeadOpptySharingClientRelationInput!): DeleteLeadOpptySharingClientRelationPayload` Soft-delete.

## Types

### LeadOpptySharingClientRelationEntity (object)

Share of a lead or opportunity with an individual user, with the access level granted.

- `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.
- `client: ClientEntity` User the lead or opportunity is shared with.
- `lead: LeadEntity` Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty.
- `oppty: OpportunityEntity` Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty.
- `clientId: ID!` Id of the user.
- `leadOpptyId: ID!` Id of the lead or opportunity being shared.
- `role: SharingRoleEnum` Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
- `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.

### LeadOpptySharingClientRelationEntityConnection (object)

Paginated list of LeadOpptySharingClientRelation records.

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

### LeadOpptySharingClientRelationEntityEdge (object)

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

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

### LeadOpptySharingClientRelationFilterInput (input)

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

- `OR: [LeadOpptySharingClientRelationFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [LeadOpptySharingClientRelationFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: LeadOpptySharingClientRelationFilterInput` 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.
- `clientId: EntityFilterStringField` Id of the user.
- `leadOpptyId: EntityFilterStringField` Id of the lead or opportunity being shared.
- `role: SharingRoleEnumFilterInput` Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `client: ClientFilterInput` User the lead or opportunity is shared with. Matches records where a related record meets these conditions.
- `lead: LeadFilterInput` Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty. Matches records where a related record meets these conditions.
- `oppty: OpportunityFilterInput` Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Matches records where a related record meets these conditions.

### LeadOpptySharingClientRelationOrderByInput (input)

Sorting of LeadOpptySharingClientRelation 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.
- `client: [ClientOrderByNestedInput!]` User the lead or opportunity is shared with. Sorts by fields of the related record, listed in order of priority.
- `lead: [LeadOrderByNestedInput!]` Lead being shared. Set when leadOpptyId resolves to a Lead; otherwise empty. Sorts by fields of the related record, listed in order of priority.
- `oppty: [OpportunityOrderByNestedInput!]` Opportunity being shared. Set when leadOpptyId resolves to an Opportunity; otherwise empty. Sorts by fields of the related record, listed in order of priority.
- `clientId: OrderByEnum` Id of the user.
- `leadOpptyId: OrderByEnum` Id of the lead or opportunity being shared.
- `role: OrderByEnum` Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### CreateLeadOpptySharingClientRelationInput (input)

Field values of a new LeadOpptySharingClientRelation 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.
- `clientId: ID!` Id of the user.
- `leadOpptyId: ID!` Id of the lead or opportunity being shared.
- `role: SharingRoleEnum` Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
- `revision: Int` Revision when entity was lastly changed.

### CreateOrUpdateLeadOpptySharingClientRelationInput (input)

Field values of a LeadOpptySharingClientRelation 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.
- `clientId: ID` Id of the user.
- `leadOpptyId: ID` Id of the lead or opportunity being shared.
- `role: SharingRoleEnum` Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
- `revision: Int` Revision when entity was lastly changed.

### DeleteLeadOpptySharingClientRelationInput (input)

Id of the LeadOpptySharingClientRelation 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 lead or opportunity being shared.

### UpdateLeadOpptySharingClientRelationInput (input)

Id of a LeadOpptySharingClientRelation 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.
- `clientId: ID` Id of the user.
- `leadOpptyId: ID` Id of the lead or opportunity being shared.
- `role: SharingRoleEnum` Access the sharing gives the user on the lead or opportunity: Watcher can view it, Editor can view and edit it.
- `revision: Int` Revision when entity was lastly changed.

### BulkUpdateLeadOpptySharingClientRelationPayload (object)

Result of the bulkUpdateLeadOpptySharingClientRelation mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreateLeadOpptySharingClientRelationPayload (object)

Result of the createLeadOpptySharingClientRelation mutation.

- `leadOpptySharingClientRelation: LeadOpptySharingClientRelationEntity` 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).

### DeleteLeadOpptySharingClientRelationPayload (object)

Result of the deleteLeadOpptySharingClientRelation mutation.

- `leadOpptySharingClientRelation: LeadOpptySharingClientRelationEntity` 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).

### UpdateLeadOpptySharingClientRelationPayload (object)

Result of the updateLeadOpptySharingClientRelation mutation.

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