Docs
Numbersv4

Get a number

GET/numbers/{number}

One of the organization's numbers, with its products and channels. OAuth apps need numbers:read.

Path parameters

numberRequiredstring

The number in E.164 format, with + URL-encoded as %2B (e.g. %2B15551234567).

Headers

AuthorizationRequiredstring

Your API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.

Bearer

Returns

dataoptionalNumber
numberRequiredstring

The number in E.164 format.

productsRequiredNumberProduct[]
statusRequiredstring

The status of the number's most usable channel.

"active""pending_verification""suspended""banned"
channelsRequiredNumberChannel[]

Array of NumberChannel

channel_idRequiredstring

Channel id (ch_...), the from for sends and calls.

typeRequiredstring

Channel type for the product.

"blooio""sms""voice"
statusRequiredstring

The channel's status.

campaign_idoptionalstring | null

SMS only: the 10DLC campaign (camp_...) the number is assigned to.

assignment_statusoptionalstring

SMS only: where the number stands with its campaign. It sends texts once assigned, which needs a campaign carriers have provisioned.

"unassigned""pending""assigned""failed"
inbound_handleroptionalstring

Voice only: who answers the number's inbound calls (see VoiceInboundSettings).

"softphone""agent""api"
created_atRequiredinteger

When the number's first channel was created (epoch ms).

Response codes

200The number
400`invalid_number`.
401Your API key is missing or invalid. Pass it as a bearer token.
404`number_not_found`.

Sends a live request with your values and shows the real response below. Your key is stored only in this browser.

Request
curl -X GET https://api.blooio.com/v4/numbers/%2B15551234567 \
Response objectexample
{  "data": {    "number": "+15551234567",    "products": [      "imessage"    ],    "status": "active",    "channels": [      {        "channel_id": "ch_a1b2c3d4",        "type": "blooio",        "status": "active",        "campaign_id": "obj_a1b2c3d4",        "assignment_status": "unassigned",        "inbound_handler": "softphone"      }    ],    "created_at": 0  }}