GET
/
enterprise
/
lease
/
purchasable
curl --request GET \
  --url https://api.contiguity.co/enterprise/lease/purchasable \
  --header 'Authorization: Bearer <token>'
{
  "id": "psr_abc123",
  "object": "pool_available_adoption",
  "created_at": 123,
  "data": {
    "text": [
      {
        "type": "text",
        "number": "14155552671",
        "country": "US",
        "supports": [
          "sms"
        ],
        "carrier": "TMO",
        "data": {
          "status": "available",
          "health": "good",
          "formatted": "+1 (415) 555-2671",
          "e164": "+14155552671"
        }
      }
    ],
    "imessage": [
      {
        "type": "text",
        "number": "14155552671",
        "country": "US",
        "supports": [
          "sms"
        ],
        "carrier": "TMO",
        "data": {
          "status": "available",
          "health": "good",
          "formatted": "+1 (415) 555-2671",
          "e164": "+14155552671"
        }
      }
    ],
    "whatsapp": [
      {
        "type": "text",
        "number": "14155552671",
        "country": "US",
        "supports": [
          "sms"
        ],
        "carrier": "TMO",
        "data": {
          "status": "available",
          "health": "good",
          "formatted": "+1 (415) 555-2671",
          "e164": "+14155552671"
        }
      }
    ],
    "voice": [
      {
        "type": "text",
        "number": "14155552671",
        "country": "US",
        "supports": [
          "sms"
        ],
        "carrier": "TMO",
        "data": {
          "status": "available",
          "health": "good",
          "formatted": "+1 (415) 555-2671",
          "e164": "+14155552671"
        }
      }
    ]
  }
}

This endpoint requires an Enterprise plan.

Authorizations

​
Authorization
string
header
required

Authentication using a Bearer Token. Specify Authorization: Token YOUR_TOKEN. Bearer is allowed.

Query Parameters

​
supports
enum<string>[]

Filter by supported features

Available options:
sms,
mms,
whatsapp,
imessage,
audio
​
type
enum<string>

Filter by number type

Available options:
text,
whatsapp,
imessage
​
country
enum<string>

Filter by country code

Available options:
US,
CA,
UK,
FR
​
carrier
enum<string>

Filter by carrier

Available options:
TMO,
ATT,
CONTIGUITY

Response

200
application/json
List of available numbers
​
id
string

Unique identifier for the response

​
object
enum<string>
Available options:
pool_available_adoption
​
created_at
integer

Unix timestamp of when the response was created

​
data
object

Was this page helpful?

OverviewSend iMessage