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

# List Relationships

`GET /v2/relationships`

## Request

- Base URL: `https://api.paymongo.com`
- URL: `https://api.paymongo.com/v2/relationships`
- Auth: HTTP basic

List relationships where the authenticated account is the parent or the child.
Each relationship includes basic details of the parent and child accounts, not
just their IDs.

Results are ordered newest first and paginated with an opaque cursor. When
`has_more` is true, pass the returned `cursor` to the next call to fetch the next
page. Treat the cursor as an opaque value and URL-encode it when sending.

## Query parameters

- `parent_account_id` string
- `child_account_id` string
- `enabled` boolean
- `limit` integer
- `cursor` string

## Response `200`

Relationships retrieved successfully

- ListRelationshipsResponse
  - `data` Relationship[]: Relationships ordered newest first
    - `id` string: Unique identifier for the relationship. Prefixed with mr_
    - `parent_account_id` string: ID of the parent account in the relationship
    - `child_account_id` string: ID of the child account in the relationship
    - `enabled` boolean: Whether the relationship is enabled. Distinct from each account's own enabled flag
    - `linking_request_id` string, nullable: ID of the linking request that established the relationship. Prefixed with lr_. Null for relationships without an originating linking request
    - `policies` Policies, nullable: Permissions granted on the relationship, as resource to operation to grant. Null when nothing was granted. A full-access relationship carries the single grant "*": {"*": {...}}.
    - `parent_account` RelationshipAccount: Basic details of an account on one side of a relationship
      - `id` string: Unique identifier for the account. Prefixed with org_
      - `account_type` 'merchant' | 'consumer': The type of account
      - `activation_status` 'pending' | 'under_review' | 'activated' | 'declined': The current activation status of the account
      - `enabled` boolean: Whether the account itself is enabled. Distinct from the relationship's enabled flag
      - `trade_name` string: The account's trade name
      - `legal_name` string: The account's legal name
      - `business_type` string: The business entity type (e.g., individual, sole_proprietor, corporation)
    - `child_account` RelationshipAccount: Basic details of an account on one side of a relationship
      - `id` string: Unique identifier for the account. Prefixed with org_
      - `account_type` 'merchant' | 'consumer': The type of account
      - `activation_status` 'pending' | 'under_review' | 'activated' | 'declined': The current activation status of the account
      - `enabled` boolean: Whether the account itself is enabled. Distinct from the relationship's enabled flag
      - `trade_name` string: The account's trade name
      - `legal_name` string: The account's legal name
      - `business_type` string: The business entity type (e.g., individual, sole_proprietor, corporation)
    - `created_at` integer: Unix timestamp indicating when the relationship was created
    - `updated_at` integer: Unix timestamp indicating when the relationship was last updated
  - `has_more` boolean: Whether more relationships exist after this page
  - `cursor` string: Opaque cursor for fetching the next page. Only present when has_more is true

## Other responses

- `400`: Bad request - invalid query parameters or pagination cursor
- `401`: Unauthorized
- `500`: Internal server error

---

[API](https://skmtc.dev/paymongo/apis/accounts-api.md) - [All operations](https://skmtc.dev/paymongo/apis/accounts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paymongo/apis/accounts-api/revisions/68d0b0b08710?raw)
