SYsynctera
Accounts

List account relationships

Changed on

List all customers of an account

get/accounts/{account_id}/relationships

Request

  • Base URL
    https://api-sandbox.synctera.com/v0
  • URL
    https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships
  • Auth
    HTTP bearer

Path parameters

account_idstring uuid required
Example:57826c51-e4ff-4e57-9558-08cab6b963c7

Unique identifier for the account.

Query parameters

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d
limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

Response

List of account relationships

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "relationships": [
    {
      "ownership_percentage": 35.75
    }
  ],
  "next_page_token": "a8937a0d"
}

Changes

  • a9a5c394da16Revision changes
    • info

      added the optional property //// to the response with the status

  • a841410907f8Revision changes
    • warning

      added the new GUARANTOR enum value to the //// response property for the response status