GET /faxes/lines

List the fax numbers you can use

The account's fax-enabled numbers that this credential may use: the user's role must grant the number, and an API key's number grants narrow it further. Each number is in the exact form POST /faxes takes for from and GET /faxes takes for number.

Sending still needs fax:send and the role's Teleconsole fax permission; this list only says which numbers are yours to use.

Scope	fax:read
Role permission	Phone numbers
Cost	Free. Sends nothing.

Responses

200

The fax numbers the credential may use. An empty list when it may use none.

Field	Type	Description
[].number	string	The fax number in the exact form from and the number filter want. Copy it straight through.
[].name	string	The number's caller-ID name. Empty if none is set.

Two fax lines:

{
  "data": [
    {
      "number": "12125550188",
      "name": "Acme Billing"
    },
    {
      "number": "12125550199",
      "name": ""
    }
  ]
}

Errors

Status	Meaning
401	unauthenticated — no credential, or one that is invalid, revoked or expired. The WWW-Authenticate header names the scope the endpoint wanted.
403	Two different failures share this status, and the type tells them apart:
500	internal_error — something failed on our side. For a send, nothing was charged, guaranteed, which is what makes a retry safe.

See Errors for the full catalog and what to do about each.

Example

curl -X GET 'https://api.account.telebroad.com/api/public/v1/faxes/lines' \
  -H "Authorization: Bearer $TB_KEY"

Try it in the playground →