--- title: entities.clientStoryRead description: Read client story read records with the clientStoryRead repository, and change them with the client story read mutations. Same records as the REST ClientStoryReads entity. canonical: https://developers.coevera.com/reference/graphql/client-story-read/ section: graphql verification: schema generatedFrom: schema f155746 (2026-10-20) publisher: Coevera --- # entities.clientStoryRead Read client story read records with the clientStoryRead repository, and change them with the client story read mutations. Same records as the REST ClientStoryReads entity. REST: [ClientStoryReads](https://developers.coevera.com/reference/rest/client-story-reads.md). ## Queries - `getById(entityId: ID!): ClientStoryReadEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well. - `getByIds(entityIds: [ID!]!): [ClientStoryReadEntity!]!` 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: ClientStoryReadFilterInput, orderBy: [ClientStoryReadOrderByInput!], includeDeleted: Boolean): [ClientStoryReadEntity!]!` Returns the records that match the filter, paged with limit and offset. - `getByCriteria(filter: ClientStoryReadFilterInput, orderBy: [ClientStoryReadOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): ClientStoryReadEntityConnection` 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 - `createClientStoryRead(input: CreateClientStoryReadInput!, validationLevel: [ValidationLevel!]): CreateClientStoryReadPayload` Create one record. - `updateClientStoryRead(input: UpdateClientStoryReadInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateClientStoryReadPayload` Update fields. - `bulkUpdateClientStoryRead(input: [CreateOrUpdateClientStoryReadInput!]!, deleteInput: [DeleteClientStoryReadInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateClientStoryReadPayload` Create or update many; per-item results. - `deleteClientStoryRead(input: DeleteClientStoryReadInput!): DeleteClientStoryReadPayload` Soft-delete. ## Types ### ClientStoryReadEntity (object) Mark that a user has read an activity, email or memo in their feed, and whether they chose not to follow up on it. - `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. - `appointment: AppointmentEntity` Appointment that was read. Set when activityId resolves to an Appointment. - `task: TaskEntity` Task that was read. Set when activityId resolves to a Task. - `email: EmailEntity` Email that was read. Set when messageId resolves to an Email. - `memo: MemoEntity` Memo that was read. Set when messageId resolves to a Memo. - `owner: ClientEntity` User who read the activity or message. - `activityId: ID` Id of the read appointment or task, or empty when this read points to a message. - `messageId: ID` Id of the read email or memo, or empty when this read points to an activity. - `noFollow: Boolean` When true, the user explicitly chose not to follow up on this item. - `ownerId: ID!` Id of the reading user. - `readAt: DateTime!` Timestamp the user marked the item as read. - `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. ### ClientStoryReadEntityConnection (object) Paginated list of ClientStoryRead records. - `pageInfo: PageInfo!` Pagination data for this connection. - `edges: [ClientStoryReadEntityEdge]!` Contains the nodes in this connection. - `totalCount: Int` Total number of items in the connection. ### ClientStoryReadEntityEdge (object) A Relay edge containing a `ClientStoryReadEntity` and its cursor. - `node: ClientStoryReadEntity` The item at the end of the edge - `cursor: String!` A cursor for use in pagination ### ClientStoryReadFilterInput (input) Filter conditions for ClientStoryRead records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations. - `OR: [ClientStoryReadFilterInput!]` Matches records that meet at least one of the listed filters. - `AND: [ClientStoryReadFilterInput!]` Matches records that meet all of the listed filters. - `NOT: ClientStoryReadFilterInput` 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. - `activityId: EntityFilterStringField` Id of the read appointment or task, or empty when this read points to a message. - `messageId: EntityFilterStringField` Id of the read email or memo, or empty when this read points to an activity. - `noFollow: Boolean` When true, the user explicitly chose not to follow up on this item. - `ownerId: EntityFilterStringField` Id of the reading user. - `readAt: EntityFilterDateTimeField` Timestamp the user marked the item as read. - `revision: EntityFilterNumberField` Revision when entity was lastly changed. - `appointment: AppointmentFilterInput` Appointment that was read. Set when activityId resolves to an Appointment. Matches records where a related record meets these conditions. - `task: TaskFilterInput` Task that was read. Set when activityId resolves to a Task. Matches records where a related record meets these conditions. - `email: EmailFilterInput` Email that was read. Set when messageId resolves to an Email. Matches records where a related record meets these conditions. - `memo: MemoFilterInput` Memo that was read. Set when messageId resolves to a Memo. Matches records where a related record meets these conditions. - `owner: ClientFilterInput` User who read the activity or message. Matches records where a related record meets these conditions. ### ClientStoryReadOrderByInput (input) Sorting of ClientStoryRead 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. - `appointment: [AppointmentOrderByNestedInput!]` Appointment that was read. Set when activityId resolves to an Appointment. Sorts by fields of the related record, listed in order of priority. - `task: [TaskOrderByNestedInput!]` Task that was read. Set when activityId resolves to a Task. Sorts by fields of the related record, listed in order of priority. - `email: [EmailOrderByNestedInput!]` Email that was read. Set when messageId resolves to an Email. Sorts by fields of the related record, listed in order of priority. - `memo: [MemoOrderByNestedInput!]` Memo that was read. Set when messageId resolves to a Memo. Sorts by fields of the related record, listed in order of priority. - `owner: [ClientOrderByNestedInput!]` User who read the activity or message. Sorts by fields of the related record, listed in order of priority. - `activityId: OrderByEnum` Id of the read appointment or task, or empty when this read points to a message. - `messageId: OrderByEnum` Id of the read email or memo, or empty when this read points to an activity. - `noFollow: OrderByEnum` When true, the user explicitly chose not to follow up on this item. - `ownerId: OrderByEnum` Id of the reading user. - `readAt: OrderByEnum` Timestamp the user marked the item as read. - `revision: OrderByEnum` Revision when entity was lastly changed. ### CreateClientStoryReadInput (input) Field values of a new ClientStoryRead 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. - `activityId: ID` Id of the read appointment or task, or empty when this read points to a message. - `messageId: ID` Id of the read email or memo, or empty when this read points to an activity. - `noFollow: Boolean` When true, the user explicitly chose not to follow up on this item. - `ownerId: ID!` Id of the reading user. - `readAt: DateTime!` Timestamp the user marked the item as read. - `revision: Int` Revision when entity was lastly changed. ### CreateOrUpdateClientStoryReadInput (input) Field values of a ClientStoryRead 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. - `activityId: ID` Id of the read appointment or task, or empty when this read points to a message. - `messageId: ID` Id of the read email or memo, or empty when this read points to an activity. - `noFollow: Boolean` When true, the user explicitly chose not to follow up on this item. - `ownerId: ID` Id of the reading user. - `readAt: DateTime` Timestamp the user marked the item as read. - `revision: Int` Revision when entity was lastly changed. ### DeleteClientStoryReadInput (input) Id of the ClientStoryRead 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 read appointment or task, or empty when this read points to a message. - `messageId: ID` Id of the read email or memo, or empty when this read points to an activity. ### UpdateClientStoryReadInput (input) Id of a ClientStoryRead 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. - `activityId: ID` Id of the read appointment or task, or empty when this read points to a message. - `messageId: ID` Id of the read email or memo, or empty when this read points to an activity. - `noFollow: Boolean` When true, the user explicitly chose not to follow up on this item. - `ownerId: ID` Id of the reading user. - `readAt: DateTime` Timestamp the user marked the item as read. - `revision: Int` Revision when entity was lastly changed. ### BulkUpdateClientStoryReadPayload (object) Result of the bulkUpdateClientStoryRead mutation. - `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed. ### CreateClientStoryReadPayload (object) Result of the createClientStoryRead mutation. - `clientStoryRead: ClientStoryReadEntity` 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). ### DeleteClientStoryReadPayload (object) Result of the deleteClientStoryRead mutation. - `clientStoryRead: ClientStoryReadEntity` 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). ### UpdateClientStoryReadPayload (object) Result of the updateClientStoryRead mutation. - `clientStoryRead: ClientStoryReadEntity` 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 FirstClientStoryReads { entities { clientStoryRead { 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 FirstClientStoryReads { entities { clientStoryRead { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}' ```