---
title: "List relationships"
method: GET
path: "/relationships"
tags: ["Relationships"]
---

# List relationships

`GET /relationships`

Retrieves paginated list of relationships viewable by the authorized requester.

## Query parameters

- `to_business_id` string[]
- `from_person_id` string[]
- `relationship_type` string[]
- `from_business_id` string[]
- `page_token` string — Optional pagination token to be provided to retrieve subsequent pages, returned from previous get
- `id` string[]
- `limit` integer — Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

## Response `200`

Relationship representation.

- RelationshipsList
  - `relationships` RelationshipIn[], required — Array of business/person relationships.
    - union
      - object — Denotes the relationship between specified businesses.
        - `additional_data` AdditionalOwnerData, required — Contains additional information about the relationship.
          - `percent_ownership` number, double, required — Percentage ownership of the related business.
        - `creation_time` string, date-time — The date and time the resource was created.
        - `from_business_id` string, uuid, required — Unique ID for the subject business.
        - `id` string, uuid — Relationship unique identifier.
        - `last_updated_time` string, date-time — The date and time the resource was last updated.
        - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
        - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', required — The relationship type. One of the following: * `BENEFICIAL_OWNER_OF` – a person who directly or indirectly owns a portion of the business. * `MANAGING_PERSON_OF` – a person who is an officer, director, or other notable person of an organization. * `OWNER_OF` – a business with ownership of another business. * `PAYER_PAYEE` - a person or business with a payer payee relationship with another person or business
        - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
        - `to_business_id` string, uuid, required — Unique ID for the related business.
      - object — Denotes the relationship between specified person and business.
        - `additional_data` AdditionalData, required — Contains additional information about the relationship.
          - `title` 'DIRECTOR' | 'FOUNDER' | 'OFFICER' | 'OTHER', required — The professional role or position the person holds at the related organization.
          - `title_other` string — The specific title or professional role at the related organization (required if not one of: `DIRECTOR`, `OFFICER`, `FOUNDER`).
        - `creation_time` string, date-time — The date and time the resource was created.
        - `from_person_id` string, uuid, required — Unique ID for the subject person.
        - `id` string, uuid — Relationship unique identifier.
        - `last_updated_time` string, date-time — The date and time the resource was last updated.
        - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
        - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', required — The relationship type. One of the following: * `BENEFICIAL_OWNER_OF` – a person who directly or indirectly owns a portion of the business. * `MANAGING_PERSON_OF` – a person who is an officer, director, or other notable person of an organization. * `OWNER_OF` – a business with ownership of another business. * `PAYER_PAYEE` - a person or business with a payer payee relationship with another person or business
        - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
        - `to_business_id` string, uuid, required — Unique ID for the related business.
      - object — Denotes the relationship between specified person and business.
        - `additional_data` AdditionalOwnerData, required — Contains additional information about the relationship.
          - `percent_ownership` number, double, required — Percentage ownership of the related business.
        - `creation_time` string, date-time — The date and time the resource was created.
        - `from_person_id` string, uuid, required — Unique ID for the subject person.
        - `id` string, uuid — Relationship unique identifier.
        - `last_updated_time` string, date-time — The date and time the resource was last updated.
        - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
        - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', required — The relationship type. One of the following: * `BENEFICIAL_OWNER_OF` – a person who directly or indirectly owns a portion of the business. * `MANAGING_PERSON_OF` – a person who is an officer, director, or other notable person of an organization. * `OWNER_OF` – a business with ownership of another business. * `PAYER_PAYEE` - a person or business with a payer payee relationship with another person or business
        - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
        - `to_business_id` string, uuid, required — Unique ID for the related business.
      - object — > 🚧 Alpha > The PAYER_PAYEE relationship is Alpha. We may make breaking changes to this schema. PAYER_PAYEE denotes the relationship between specified person or business as a payer or payee to a person or businesses. One from_person_id/from_business_id must be provided, and one of to_person_id/to_business_id must be provided.
        - `additional_data` PayerPayeeAdditionalData, required — Contains the type of transfer for the payer and payee relationship
          - `transfer_type` 'CREDIT' | 'DEBIT' | 'DEBIT_OR_CREDIT', required
        - `creation_time` string, date-time — The date and time the resource was created.
        - `from_business_id` string, uuid — Unique ID for the subject business.
        - `from_person_id` string, uuid — Unique ID for the subject person.
        - `id` string, uuid — Relationship unique identifier.
        - `last_updated_time` string, date-time — The date and time the resource was last updated.
        - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
        - `relationship_type` 'BENEFICIAL_OWNER_OF' | 'MANAGING_PERSON_OF' | 'OWNER_OF' | 'PAYER_PAYEE', required — The relationship type. One of the following: * `BENEFICIAL_OWNER_OF` – a person who directly or indirectly owns a portion of the business. * `MANAGING_PERSON_OF` – a person who is an officer, director, or other notable person of an organization. * `OWNER_OF` – a business with ownership of another business. * `PAYER_PAYEE` - a person or business with a payer payee relationship with another person or business
        - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
        - `to_business_id` string, uuid — Unique ID for the related business.
        - `to_person_id` string, uuid — Unique ID for the related person.
  - `next_page_token` string — If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden error
- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/revisions/b0d812e6cdd0/schema)