GetFamily

POST

https://api.cbf.tcn.com/api/v0alpha/ana/admin/GetFamily

gets all relations in which the client is involved grouped by whether the
client is the parent or child account

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "org_id": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/ana/admin/GetFamily' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "org_id": "string"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "client_sid": 0,
    "client_name": "string",
    "parents": {
        "relations": [
            {
                "client_sid": 0,
                "client_name": "string",
                "relation_initiation": "1s",
                "relation_initiator": "string",
                "relation_termination": "1s",
                "relation_terminator": "string",
                "is_current": true,
                "org_id": "string"
            }
        ]
    },
    "children": {
        "relations": [
            {
                "client_sid": 0,
                "client_name": "string",
                "relation_initiation": "1s",
                "relation_initiator": "string",
                "relation_termination": "1s",
                "relation_terminator": "string",
                "is_current": true,
                "org_id": "string"
            }
        ]
    }
}

🟢200Success

Modified at 2025-09-26 15:44:58

GetAccessibleClients

GetAllowedDataVisibility