List numbers
/numbersEvery 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
AuthorizationRequiredstringYour API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.
Query parameters
productsoptionalstringComma-separated imessage, sms, voice. Returns numbers carrying any of them; omit for every number.
limitoptionalintegerMaximum number of items to return per page. Must be between 1 and 200; defaults to 50. Combine with cursor to paginate.
cursoroptionalstringOpaque pagination cursor. Pass the next_cursor value from a previous response to fetch the next page; omit it on the first request.
Returns
dataoptionalNumber[]
dataoptionalNumber[]Array of Number
numberRequiredstringThe number in E.164 format.
productsRequiredNumberProduct[]statusRequiredstringThe status of the number's most usable channel.
"active""pending_verification""suspended""banned"channelsRequiredNumberChannel[]
channelsRequiredNumberChannel[]Array of NumberChannel
channel_idRequiredstringChannel id (ch_...), the from for sends and calls.
typeRequiredstringChannel type for the product.
"blooio""sms""voice"statusRequiredstringThe channel's status.
campaign_idoptionalstring | nullSMS only: the 10DLC campaign (camp_...) the number is assigned to.
assignment_statusoptionalstringSMS 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_handleroptionalstringVoice only: who answers the number's inbound calls (see VoiceInboundSettings).
"softphone""agent""api"created_atRequiredintegerWhen the number's first channel was created (epoch ms).
has_moreoptionalbooleannext_cursoroptionalstring | nullResponse codes
Sends a live request with your values and shows the real response below. Your key is stored only in this browser.
curl -X GET https://api.blooio.com/v4/numbers?products=sms%2Cvoice&limit=50&cursor=string \{ "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"}