List Relationships

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.

You can also find linked accounts by their owner's email with
parent_account_email or child_account_email. Filters combine, so only
relationships that match every filter you send are returned. One email can own
several of your linked accounts, so you may get more than one result. Emails are
not included in the response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by parent account ID

string

Filter by the email of the parent account's owner. This is the account holder's email (person.email_address), or, if the account has none, the email its owner uses to log in to the PayMongo Dashboard. Team members' emails don't match. Matching is exact but not case-sensitive, and you don't need to encode a +. An email that matches no account returns an empty list, and so does an invalid or empty value.

string

Filter by child account ID

string

Filter by the email of the child account's owner. This is the account holder's email (person.email_address), or, if the account has none, the email its owner uses to log in to the PayMongo Dashboard. Team members' emails don't match. Matching is exact but not case-sensitive, and you don't need to encode a +. An email that matches no account returns an empty list, and so does an invalid or empty value.

boolean

Filter by the relationship's enabled status

integer
1 to 100
Defaults to 20

Number of relationships per page (1-100). Defaults to 20

string

Opaque pagination cursor from a previous response. Omit to fetch the first page

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json