Search available numbers

GET/v1/numbers/available

Query Parameters

area_codestring
Example: 415.

Responses

200Page of AvailableNumber
Available numbers
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429Error
Rate limit or quota exceeded

Response Fields

The body is a page: data (the array), has_more, and next_cursor (null on the last page). Each item in data:

objectavailable_number
phone_numberstring
localitystring
regionstring

Errors

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.

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

import { TextKit } from 'jointextkit'; // npm install jointextkit

const sms = new TextKit(process.env.TEXTKIT_API_KEY);

const available = await sms.numbers.available({ areaCode: '415' });

console.log(available.data.map((n) => n.phone_number));

Response 200

{
  "data": [
    {
      "object": "available_number"
    }
  ],
  "has_more": true,
  "next_cursor": null
}