---
title: "LeadOpptyContactRelations.list"
method: GET
path: "/entities/LeadOpptyContactRelations"
tags: ["Lead & Opportunity"]
---

# LeadOpptyContactRelations.list

`GET /entities/LeadOpptyContactRelations`

Returns all defined LeadOpptyContactRelations

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

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` LeadOpptyContactRelation[]
    - `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.
    - `contact` string, uri, required — Contact linked to the lead or opportunity. 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.
    - `lead_oppty_contact_group_relation` string, uri — Contact group on the org chart this contact belongs to, or empty for ungrouped contacts. Relation to LeadOpptyContactGroupRelation. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'LeadOpptyContactGroupRelation' object for properties.
    - `lead` string, uri — Lead the contact 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 contact 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.
    - `comment` string — Free-form note describing this contact link.
    - `contact_id` string, uuid, required — Id of the contact.
    - `is_primary` boolean, required — True for the row that represents the primary related entity for this record. Setting is_primary to true on a row automatically clears it on any other primary row.
    - `lead_oppty_contact_group_relation_id` string, uuid — Id of the contact group.
    - `lead_oppty_id` string, uuid, required — Id of the lead or opportunity this link belongs to.
    - `position_in_group` object — Org-chart layout position of the contact within its group, as a JSON object {"x": <int>, "y": <int>}.
    - `relationship` 0 | 1 | 2 | 3 — Org-chart relationship of the contact within the lead/opportunity hierarchy. Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong
    - `revision` integer — Revision when entity was lastly changed.
    - `sales_roles` string[] — Sales roles assigned to the contact for this lead or opportunity.
  - `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)