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

# MessageRelations.list

`GET /entities/MessageRelations`

Returns all defined MessageRelations

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

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` MessageRelation[]
    - `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.
    - `account` string, uri — Account the message is linked to, or empty when not linked to an account. Relation to Account. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Account' object for properties.
    - `contact` string, uri — Contact the message is linked to, or empty when not linked to a contact. Relation to Contact. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Contact' object for properties.
    - `custom_entity` string, uri — Custom entity record the message is linked to, or empty when not linked. Relation to CustomEntity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CustomEntity' object for properties.
    - `lead` string, uri — Lead the message is linked to. Set when lead_oppty_id resolves to a Lead; otherwise empty. Relation to Lead. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Lead' object for properties.
    - `oppty` string, uri — Opportunity the message is linked to. Set when lead_oppty_id resolves to an Opportunity; otherwise empty. Relation to Opportunity. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Opportunity' object for properties.
    - `email` string, uri — Email side of the link. 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 side of the link. 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.
    - `project` string, uri — Project the message is linked to, or empty when not linked. Relation to Project. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Project' object for properties.
    - `quote` string, uri — Quote the message is linked to, or empty when not linked. Relation to Quote. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Quote' object for properties.
    - `account_id` string, uuid — Id of the linked account.
    - `contact_id` string, uuid — Id of the linked contact.
    - `custom_entity_id` string, uuid — Id of the linked custom entity record.
    - `lead_oppty_id` string, uuid — Id of the lead or opportunity the message is linked to, or empty when not linked.
    - `message_id` string, uuid, required — Id of the email or memo on this link.
    - `project_id` string, uuid — Id of the linked project.
    - `quote_id` string, uuid — Id of the linked quote.
    - `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)