List branded caller IDs

List the branded caller ID records in your workspace, newest first.

GEThttps://api.tried.com.au/list-branded-caller-ids

Returns every branded caller ID record in your workspace, newest first. The status is the last value saved; call Refresh branded caller ID to update it.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/list-branded-caller-ids \
  -H "Authorization: Bearer $TRIED_API_KEY"

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

import os, requests

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

Response#

200 OK

A JSON array. See Create branded caller ID for the fields.

[
  {
    "branded_caller_id": "bcid_7e2a91c4d08f5b36e1a9c7d0",
    "phone_number": "+14155550123",
    "display_name": "Harbour Dental",
    "call_reason": "Appointment reminder",
    "status": "approved",
    "provider": "telnyx",
    "provider_reference": "c41f9a2e-6b07-4d1a-9e35-8f2b1d6c0a47",
    "created_timestamp": 1792396800000,
    "last_modification_timestamp": 1792483200000
  }
]

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `numbers` scope.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.