GET
/
accounts
/
{account_id}
/
relationships
List account relationships
curl --request GET \
  --url https://api-sandbox.synctera.com/v0/accounts/{account_id}/relationships \
  --header 'Authorization: Bearer <token>'
{
  "relationships": [
    {
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "person_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "relationship_type": "ACCOUNT_HOLDER"
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_id
string<uuid>
required

Unique identifier for the account.

Example:

"57826c51-e4ff-4e57-9558-08cab6b963c7"

Query Parameters

page_token
string

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

Example:

"a8937a0d"

limit
integer
default:100

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

Required range: x >= 1
Example:

100

Response

200
application/json

List of account relationships

The response is of type object.