List branches
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/branches \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/branches"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://staging-api.usetyms.com/v1/adam/branches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Branches retrieved successfully",
"data": [
{
"uuid": "br1234567890abcdef1234567890abcd",
"business_uuid": "b1b2b3...",
"name": "Lagos HQ",
"address": "12 Adeola Odeku, Victoria Island",
"state": "Lagos",
"country": "NG",
"is_default": false,
"phone": "+2348011111111",
"email": "lagos@acme.example"
}
]
}Branches
List branches
Return all branches for the business. Tag transactions with branch_uuid to track performance by location.
GET
/
branches
List branches
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/branches \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/branches"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://staging-api.usetyms.com/v1/adam/branches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Branches retrieved successfully",
"data": [
{
"uuid": "br1234567890abcdef1234567890abcd",
"business_uuid": "b1b2b3...",
"name": "Lagos HQ",
"address": "12 Adeola Odeku, Victoria Island",
"state": "Lagos",
"country": "NG",
"is_default": false,
"phone": "+2348011111111",
"email": "lagos@acme.example"
}
]
}Authorizations
Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.
Query Parameters
Page number.
Page size.
Full-text search.
Pass 1 to return only data without the status/message wrapper.
Available options:
1 Response
200 - application/json
Branch list