Skip to main content
POST
Search available numbers

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Body

application/json
areaCode
string

Israeli mobile prefix (50, 52, 53, 54, 55, 58). Omit to see all.

Example:

"55"

limit
integer
default:10
page
integer
default:1

Response

200 - application/json

Available numbers. All returned numbers are Israeli mobile numbers. The camelCase fields here surface the internal number-search response as-is.

numbers
object[]
numberType
string
pagination
object