Get Directors

Lists the active directors of a business client. Directors whose client record is closed are left out. An unknown clientId returns an empty list.

GET /core/director/{clientId}

Path Parameter

Field Name	Type	Required	Description
`clientId`	integer	TRUE	Business client identifier.

Response

Array of:

Field Name	Type	Description
`id`	integer	Director link id (use it to delete).
`directorDetails`	object	Profile of the director person (same shape as `clientDetails` in Get Full Account Details).
`deleted`	boolean	Link deleted flag.
`active`	boolean	Link active flag.
`createdDate`	string	Creation date.
`updatedDate`	string	Last update date.

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: {{tpGatewayHostUrl}}/security/authenticate

Responses

🟢200Success

application/json

Success

Bodyapplication/json

Example

[
  {
    "id": 4,
    "directorDetails": {
      "id": 103,
      "status": "Active",
      "active": true,
      "firstname": "Bola",
      "lastname": "Sample",
      "fullName": "Bola Sample",
      "mobileNo": "08000000001",
      "email": "bola@example.com",
      "clientType": "PERSON"
    },
    "deleted": false,
    "active": true,
    "createdDate": "2025-06-01",
    "updatedDate": "2025-06-01"
  }
]

🟠400| Source | Error | When |

🟠401| Source | Error | When |

🟠403| Source | Error | When |

🔴500| Source | Error | When |

Get Directors

Get Directors

Path Parameter

Response

Request

Request Code Samples

Responses

Get Directors

Get Directors#

Path Parameter#

Response#

Request

Request Code Samples

Responses

Get Directors

Path Parameter

Response