Skip to main content
GET
https://api.useadam.io/v1/adam
/
contacts
List contacts
curl --request GET \
  --url https://api.useadam.io/v1/adam/contacts \
  --header 'X-API-Key: <api-key>'
{
  "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
  }
}

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for all routes except Register business, which expects your partner secret.

Query Parameters

schema
string
page
integer
limit
integer
date_order
enum<string>
Available options:
asc,
desc

Response

200 - application/json

Paginated contact list

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.