LElead
User Account

List user account entity relationships

Changed on

List the Entities on a User Account and their relationship types.

get/v2/user_accounts/{user_account_id}/entity_relationships

Request

  • Base URL
    https://api.sandbox.lead.bank
  • URL
    https://api.sandbox.lead.bank/v2/user_accounts/{user_account_id}/entity_relationships
  • Auth
    HTTP bearer

Path parameters

user_account_idstring required

The ID of the User Account object.

Example:user_account_xyz123

User Account ID

Query parameters

limitinteger

Maximum number of results to return. Defaults to 25, max 100.

starting_afterstring

A cursor for pagination. Returns results starting after this cursor.

Response

List of entity relationships for the user account.

has_moreboolean required

Indicates whether more results are available beyond this page.

cursorstring

Cursor to retrieve the next page of results. Only present when has_more is true.

Example response

{
  "objects": [
    {
      "entity_id": "entity_xyz123",
      "relationship_type": "account_holder"
    }
  ]
}

Changes