Skip to main content
GET
Get a line
  • Credential: optional. A valid API key of the owner of the line gets the full phone number. Any other caller gets the same line with the phone number masked. See Your lines.
  • Line-scoped keys: the list of a line-scoped key is not applied here. The key gets the full phone number of any line of its account.
  • Events: none.
  • Personal data: phone_number, in full to the owner of the line, and metadata, to every caller. Request it only when needed, do not copy it into logs, tickets or other tools, and refer to a contact by an id of your own.
  • Invalid credential: it is ignored. The response is 200 with the masked number, never 401.
  • Lines that are not served: shared lines, test lines and dedicated pool lines return 404, even to their owner. Read them with GET /v1/lines/my.
  • Metadata: the metadata of the line is returned to every caller. Never put personal data or secrets in it: see Metadata.

Errors

The errors that every operation shares are in Errors.

Path Parameters

id
string
required

Id of a line: line_ followed by 25 letters or digits.

Pattern: ^line_[0-9A-Za-z]{25}$

Response

The line. phone_number is full for the owner of the line and masked for any other caller.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

A line. billing_tier, byod, shared, test_line and inbound_only tell the kinds of line apart: a rented line (two-way or inbound-only), a BYOD line, a shared line, a test line.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.