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

# entities.reportSharingClientRelation

Read report sharing client relation records with the reportSharingClientRelation repository, and change them with the report sharing client relation mutations. Same records as the REST ReportSharingClientRelations entity.

REST: [ReportSharingClientRelations](https://developers.coevera.com/reference/rest/report-sharing-client-relations.md).

## Queries

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

## Types

### ReportSharingClientRelationEntity (object)

Share of a report 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 granted shared access to the report.
- `report: ReportEntity` Report being shared.
- `clientId: ID!` Id of the user.
- `reportId: ID!` Id of the shared report.
- `role: SharingRoleEnum` Access the sharing gives the user on the report: Watcher can view it, Editor can also 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.

### ReportSharingClientRelationEntityConnection (object)

Paginated list of ReportSharingClientRelation records.

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

### ReportSharingClientRelationEntityEdge (object)

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

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

### ReportSharingClientRelationFilterInput (input)

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

- `OR: [ReportSharingClientRelationFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [ReportSharingClientRelationFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: ReportSharingClientRelationFilterInput` 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.
- `reportId: EntityFilterStringField` Id of the shared report.
- `role: SharingRoleEnumFilterInput` Access the sharing gives the user on the report: Watcher can view it, Editor can also edit it.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `client: ClientFilterInput` User granted shared access to the report. Matches records where a related record meets these conditions.
- `report: ReportFilterInput` Report being shared. Matches records where a related record meets these conditions.

### ReportSharingClientRelationOrderByInput (input)

Sorting of ReportSharingClientRelation 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 granted shared access to the report. Sorts by fields of the related record, listed in order of priority.
- `report: [ReportOrderByNestedInput!]` Report being shared. Sorts by fields of the related record, listed in order of priority.
- `clientId: OrderByEnum` Id of the user.
- `reportId: OrderByEnum` Id of the shared report.
- `role: OrderByEnum` Access the sharing gives the user on the report: Watcher can view it, Editor can also edit it.
- `revision: OrderByEnum` Revision when entity was lastly changed.

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