List contact fields

List every custom field key used by contacts in the workspace.

GEThttps://api.tried.com.au/list-contact-fields

Returns the names of all custom fields set on any contact in the workspace, sorted alphabetically. Use it to build column pickers or to see which {{variables}} contacts can supply to an agent.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/list-contact-fields \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/list-contact-fields", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const fields = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/list-contact-fields",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
fields = res.json()

Response#

200 OK

An array of strings.

["appointment_time", "plan", "seats"]

Built-in fields (first_name, last_name, email, do_not_call) are not listed.

Errors#

Status	When
`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.