Numbersv4

List numbers

GET/numbers

Every number the organization rents from Blooio, newest first: iMessage lines and Blooio SMS and Blooio Voice numbers alike, one entry per number. products says what each does and channels lists the channel behind each product. OAuth apps need numbers:read.

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

Query parameters

productsoptionalstring

Comma-separated imessage, sms, voice. Returns numbers carrying any of them; omit for every number.

limitoptionalinteger

Maximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with cursor to paginate.

cursoroptionalstring

Opaque pagination cursor. Pass the next_cursor value from a previous response to fetch the next page; omit it on the first request.

Returns

dataoptionalNumber[]

Array of Number

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).

has_moreoptionalboolean
next_cursoroptionalstring | null

Response codes

200A page of numbers
400`invalid_products`, `invalid_cursor`, or `invalid_limit`.
401Your API key is missing or invalid. Pass it as a bearer token.

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?products=sms%2Cvoice&limit=50&cursor=string \
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    }  ],  "has_more": true,  "next_cursor": "string"}