---
title: "MessageSharingClientRelations.list"
method: GET
path: "/entities/MessageSharingClientRelations"
tags: ["Message"]
---

# MessageSharingClientRelations.list

`GET /entities/MessageSharingClientRelations`

Returns all defined MessageSharingClientRelations

## 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 MessageSharingClientRelations

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` MessageSharingClientRelation[]
    - `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.
    - `client` string, uri, required — User the message is shared with. 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.
    - `email` string, uri — Email being shared. Set when message_id resolves to an Email; otherwise empty. 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 being shared. Set when message_id resolves to a Memo; otherwise empty. 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.
    - `client_id` string, uuid, required — Id of the user.
    - `message_id` string, uuid, required — Id of the email or memo being shared.
    - `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/revisions/e8c12ae60aca/schema)