List contacts
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/contacts \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/contacts"
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/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Contacts retrieved successfully",
"data": [
{
"uuid": "aa0e8400-e29b-41d4-a716-446655440006",
"name": "John Smith",
"email": "john@example.com",
"phone": "+1234567890",
"type": "customer"
}
],
"meta": {
"page": 1,
"limit": 20,
"total": 1
}
}Contacts
List contacts
GET
/
contacts
List contacts
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/contacts \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/contacts"
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/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Contacts retrieved successfully",
"data": [
{
"uuid": "aa0e8400-e29b-41d4-a716-446655440006",
"name": "John Smith",
"email": "john@example.com",
"phone": "+1234567890",
"type": "customer"
}
],
"meta": {
"page": 1,
"limit": 20,
"total": 1
}
}Contacts are customers and vendors used on invoices, bills, and other transactions.
Authorizations
Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.
Query Parameters
Available options:
asc, desc Response
200 - application/json
Paginated contact list