Skip to main content
GET
search available numbers

Authorizations

Authorization
string
header
required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Query Parameters

pattern
string | null

digits the number should contain, e.g. an area prefix like 8046.

Maximum string length: 15
Pattern: ^[0-9]*$
city
string | null

filter by city, e.g. Bangalore.

Maximum string length: 64
limit
integer
default:20

page size (1–100, default 25).

Required range: 1 <= x <= 20
offset
integer
default:0

skip this many results.

Required range: x >= 0

Response

ok.

items
AvailableNumber · object[]
required
totalCount
integer
required
limit
integer
required
offset
integer
required