---
title: "ClientStoryReads.list"
method: GET
path: "/entities/ClientStoryReads"
tags: ["Client"]
---

# ClientStoryReads.list

`GET /entities/ClientStoryReads`

Returns all defined ClientStoryReads

## Query parameters

- `include-deleted` boolean
- `first` integer
- `last` integer
- `before` string
- `after` string
- `expand` string
- `order-by` string
- `filter` object
- `filter-op` object
- `load-only` string

## Response `200`

list of ClientStoryReads

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` ClientStoryRead[]
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `appointment` string, uri — Appointment that was read. Set when activity_id resolves to an Appointment. Relation to Appointment. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Appointment' object for properties.
    - `task` string, uri — Task that was read. Set when activity_id resolves to a Task. Relation to Task. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Task' object for properties.
    - `email` string, uri — Email that was read. Set when message_id resolves to an Email. Relation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties.
    - `memo` string, uri — Memo that was read. Set when message_id resolves to a Memo. Relation to Memo. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Memo' object for properties.
    - `owner` string, uri, required — User who read the activity or message. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `activity_id` string, uuid — Id of the read appointment or task, or empty when this read points to a message.
    - `message_id` string, uuid — Id of the read email or memo, or empty when this read points to an activity.
    - `no_follow` boolean — When true, the user explicitly chose not to follow up on this item.
    - `owner_id` string, uuid, required — Id of the reading user.
    - `read_at` string, date-time, required — Timestamp the user marked the item as read.
    - `revision` integer — Revision when entity was lastly changed.
  - `page_info` object — Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.
    - `start_cursor` string — Start cursor of result set.
    - `end_cursor` string — End cursor of result set.
    - `has_previous_page` boolean — If result set has previous page (if yes, use start_cursor value in before parameter to load it).
    - `has_next_page` boolean — If result set has next page (if yes, use end_cursor value in after parameter to load it).

## Other responses

- `500` — unexpected error

---

[API](https://skmtc.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/versions/e8c12ae60aca/schema)