Introduction

The Relationships API lets you view the parent-child links between your account and the accounts connected to it. Every relationship is direct and one-directional: it links exactly two accounts, with one side as the parent and the other as the child. For the full linking model, see the Linked Accounts guide.

All endpoints listed below support the use of test secret keys. Authenticating with a test key will return mock data, allowing you to safely verify the expected response structure and fields.

How a Relationship Is Established

There are two ways a relationship comes to exist:

• Create an account - the parent creates the child account directly via the API. See the Accounts section.
• Invite - the parent invites an existing or new account in through a linking request. Relationships established this way carry the originating linking_request_id; for all others the field is null.

Relationships are read-only through the API. They cannot be created, updated, or deleted directly. Use the endpoints in this section to list the relationships your account is part of and to retrieve a single relationship by ID.

Reading a Relationship

Each relationship carries its own enabled flag indicating whether the link between the two accounts is active. It also includes basic details of both linked accounts as parent_account and child_account, so you can identify each account without fetching it separately.

See the Relationship Resource for the full field reference.