Search available phone numbers
Search the OmniDimension number shop for phone numbers available to buy in a region. Price and validity are flat per region, so every result shows the same monthly_rental_usd and validity_days, and that is the exact amount a purchase will charge.
regionstring · enumrequiredRegion to search in.
patternstringDigits or prefix to match within the number.
pageintegerPage of results to return.
limitintegerResults per page.
user_idintegerReseller accounts only: the client to act on. Omit it to act on your own account.
curl -X GET 'https://backend.omnidim.io/api/v1/phone_number/search?region=US&pattern=555&page=1&limit=20' \ -H 'Authorization: Bearer YOUR_API_KEY'
{ "success": true, "region": "US", "numbers": [ { "phone_number": "+15551234567", "monthly_rental_usd": 5, "validity_days": 30, "region": "US", "kyc_required": false } ], "total": 1, "page": 1, "limit": 20, "total_pages": 1 }
Authorization
BearerAuth Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
In: header
Query Parameters
Region to search in.
"IN" | "US"Digits or prefix to match within the number.
Page of results to return.
11 <= valueResults per page.
201 <= value <= 150Reseller accounts only: the client to act on. Omit it to act on your own account.
Response Body
application/json
application/json
application/json
application/json
application/json
Searching does not reserve anything. A number is claimed only when a purchase starts, so a number you saw a moment ago can be gone by the time you buy it.
Next step: purchase a number, or read the flow end to end in Buy a number over the API.
List phone numbers
Retrieve the phone numbers on your account, whether you bought them from the OmniDimension number shop or imported your own.
Purchase a phone number
Buy a phone number from the OmniDimension number shop. The monthly rental comes out of your wallet and the number is added to your account, ready to attach to an agent.