---
title: "ContactAccountRelations.list"
method: GET
path: "/entities/ContactAccountRelations"
tags: ["Contact"]
---

# ContactAccountRelations.list

`GET /entities/ContactAccountRelations`

Returns all defined ContactAccountRelations

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

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` ContactAccountRelation[]
    - `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, required — Account the contact is linked to. 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, required — Contact linked to the account. 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.
    - `account_id` string, uuid, required — Id of the account.
    - `comment` string — Free-form note describing this contact-account link.
    - `contact_id` string, uuid, required — Id of the contact.
    - `is_assistant` boolean — True when the contact acts as an assistant on the account org chart. Assistant relations cannot have child relations.
    - `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.
    - `is_sibling` boolean — True when the contact is a sibling node on the account org chart (no parent/child reporting line).
    - `position` string — Job title or position the contact holds at the account.
    - `relationship` 0 | 1 | 2 | 3 — Org-chart relationship of the contact within the account hierarchy. Integer enum value: 0 - NoRelationship, 1 - Weak, 2 - Moderate, 3 - Strong
    - `revision` integer — Revision when entity was lastly changed.
    - `account_roles` string[] — Roles the contact holds within the linked account.
  - `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)