Look up a phone number

GET /v1/lookup/{phone}

Carrier, line type, and caller name for any US/Canada number.

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Path parameters

Name	Type	Required	Description
`phone`	string	Yes	Example: `+14155550132`.

Responses

Status	Meaning	Body
200	Lookup result	`Lookup`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
429	Rate limit or quota exceeded	`Error`

200: `Lookup` fields

Field	Type	Description
`phone_number`	string
`valid`	boolean
`line_type`	string	Nullable. Example: `mobile`.
`carrier`	object
`carrier.name`	string	Nullable.
`carrier.type`	string	Nullable.
`caller_name`	string	Nullable.

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/lookup/+14155550132" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const lookup = await sms.lookup.phone('+14155550132');

console.log(lookup.line_type, lookup.carrier);

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

lookup = client.lookup.phone("+14155550132")

print(lookup["line_type"], lookup["carrier"])