Get Offices#
Retrieves the offices (branches) visible to the integration user.Response#
| Field Name | Type | Description |
|---|
| id | integer | Unique identifier of the office. |
| name | string | Name of the office. |
| nameDecorated | string | Name indented to show the office hierarchy. |
| externalId | string | External identifier of the office. |
| hierarchy | string | Hierarchy path of the office. |
Request
Add the parameter Authorization
to Headers，whose value is to concatenate the Token after the Bearer. Example:Authorization: Bearer ********************
Token URL: {{tpGatewayHostUrl}}/security/authenticate
or
Request Code Samples
curl --location '/core/offices'
Responses
[
{
"id": 1,
"name": "Head Office",
"nameDecorated": "Head Office",
"externalId": "HO",
"hierarchy": "."
},
{
"id": 2,
"name": "Lagos Branch",
"nameDecorated": ".... Lagos Branch",
"externalId": "LG01",
"hierarchy": ".2."
}
]
Modified at 2026-11-02 05:49:15
