List contacts

List contacts with search, a do-not-call filter, call counts and the last call time.

GEThttps://api.tried.com.au/list-contacts

Returns contacts in the workspace, most recently changed first. Each contact includes how many calls are linked to it and when the last one was created.

Request#

Query parameters:

Field	Type	Required	Description
`search`	string	No	Case-insensitive match on first name, last name or email, or a substring of the phone number (spaces are removed before matching).
`do_not_call`	string	No	`true` or `false`. Returns only contacts with that flag.
`limit`	integer	No	1 to 5000. Default `1000`.

Example request#

curl "https://api.tried.com.au/list-contacts?search=nguyen&limit=50" \
  -H "Authorization: Bearer $TRIED_API_KEY"

const params = new URLSearchParams({ search: "nguyen", limit: "50" });
const res = await fetch(`https://api.tried.com.au/list-contacts?${params}`, {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const contacts = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/list-contacts",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
    params={"search": "nguyen", "limit": 50},
)
contacts = res.json()

Response#

200 OK

An array of contacts, ordered by last_modification_timestamp, newest first. The list is not paginated; raise limit up to 5000.

[
  {
    "contact_id": "contact_4b8e2f1a9c3d5e7f6a0b2c4d",
    "phone_number": "+61412345678",
    "first_name": "Sam",
    "last_name": "Nguyen",
    "email": "sam@example.com",
    "custom_fields": { "plan": "Pro" },
    "do_not_call": false,
    "created_timestamp": 1760850000000,
    "last_modification_timestamp": 1760853600000,
    "call_count": 4,
    "last_call_timestamp": 1760853000000
  }
]

Field	Type	Description
`call_count`	integer	Calls linked to the contact.
`last_call_timestamp`	integer or null	Unix ms creation time of the newest linked call, or `null` with no calls.

The other fields are described in Create contact.

Errors#

Status	When
`400`	A query parameter fails validation, for example `limit: Number must be less than or equal to 5000`.
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `calls` scope.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Retell lists contacts with POST /list-contacts and a JSON body that returns a paginated object. Tried uses GET /list-contacts with query parameters and returns a plain array.