List your allocated numbers
GET
/v1/numbers
for await (const allocated of bird.numbers.list({ country_code: "GB" })) {
// kind distinguishes a number you bought from one Bird manages.
console.log(allocated.number, allocated.kind, allocated.status);
}for allocated in client.numbers.list(country_code="GB"):
# kind distinguishes a number you bought from one Bird manages.
print(allocated.number, allocated.kind, allocated.status)for allocated, err := range client.Numbers.List(context.Background(), bird.NumbersListParams{
CountryCode: "GB",
}) {
if err != nil {
log.Fatal(err)
}
// Kind distinguishes a number you bought from one Bird manages.
fmt.Println(allocated.Number, allocated.Kind, allocated.Status)
}$page = $bird->numbers->list(['country_code' => 'GB']);
foreach ($page as $allocated) {
// kind distinguishes a number you bought from one Bird manages.
echo $allocated->getNumber(), ' ', $allocated->getKind(), ' ', $allocated->getStatus(), "\n";
}bird numbers listcurl -X GET "https://us1.platform.bird.com/v1/numbers" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"Response200
{
"data": [
{
"id": "nda_01krdgeqcxet5s7t44vh8rt9mg",
"kind": "dedicated",
"country_code": "US",
"number_type": "mobile",
"capabilities": [
"sms"
],
"status": "active",
"ownership": {
"submission_id": "csb_01krdgeqcxet5s7t44vh8rt9mg",
"status": "needs_input",
"next": [
{
"kind": "operation"
}
]
}
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns a paginated list of the phone numbers currently allocated to your workspace, newest first. Each entry is either a dedicated number you bought or a shared number managed for you, as its kind field indicates. Pass number to look one up, or narrow the list with country_code, number_type, prefix, and capabilities. An allocated number is not always enough to send from it: some countries also require an approved registration for the sender.
Query Parameters
number
string
Return only the number matching these digits. Give a full number with its country code, however your own records spell it: +12025550188, 12025550188, 0012025550188, and +1 202 555 0188 all resolve to the same number. Spacing and punctuation are fine once a leading + or 00 marks the country code, or when country_code names the country; a grouped spelling without either is refused rather than guessed at, and a national spelling (bare digits without the country code) matches only when country_code names the country. A short code is matched on its bare digits instead, and since the same short code can be allocated in more than one country, pass country_code alongside it to name which one. This filter narrows the list like the others rather than replacing them, so a country or capability filter still applies. To match a range of numbers rather than one, use prefix.
country_code
string
Filter by the country a number belongs to, as an ISO 3166-1 alpha-2 code.
number_type
string
Return only allocated numbers of this physical type after applying the country and prefix filters.
Possible values (may grow over time): mobile, local, national, short_code, short_code_fteu, toll_free
prefix
string
Return only numbers that start with these digits. With country_code, the digits are national ones, matched right after the country dial code: with country_code=US, prefix=212 returns the +1 212 area-code numbers allocated to you. Leave out the dial code and any national dialing prefix such as a leading 0; short codes never match a country-anchored prefix search. Without country_code, the digits are matched from the start of each stored number, ignoring a leading +, so short codes are reachable and a full number in digits finds itself. Digits only: up to 10 of them with country_code, 15 without.
capabilities
array
Filter by capability. Repeat the parameter to require several at once: capabilities=sms&capabilities=voice returns only numbers that support both.
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
Response Payload
data
array of object
required
Show child attributes
data.id
string
required
Identifier of this allocated number. Pass it as number_id to read this number, or to release it when kind is dedicated.
data.kind
string
required
How this number is allocated. dedicated belongs to your workspace and is billed as a subscription. shared is provided through Bird-managed shared infrastructure and is not owned or billed as a workspace subscription.
Possible values: dedicated, shared
data.number
string
required
Phone number in E.164 format.
data.country_code
string
required
data.number_type
string
required
Physical type of this phone number.
data.capabilities
array of string
required
Capabilities supported by this number.
data.status
string
required
The allocation and ownership-approval status of this number.
- active means this number is allocated to your workspace and usable.
- pending_ownership_registration means this number is allocated to your workspace and billed, but outbound SMS and both inbound and outbound voice calls are blocked until ownership registration is approved and activation completes, or the ownership requirement is withdrawn. This ownership status does not gate inbound SMS or WhatsApp. Read ownership.status and ownership.next for the current decision and remaining work.
- released means this number is no longer allocated to your workspace.
An allocated number is not always enough to send from it: some destination
countries also require an approved registration for the sender.
Possible values: active, pending_ownership_registration, released
data.allocated_at
string
required
When this number was allocated to your workspace.
data.released_at
nullable string
When this number was released. null while it is still allocated to your workspace.
data.ownership
nullable object
Ownership paperwork and activation progress. null when no ownership requirements, recorded block, or recorded decision apply, or when requirements or progress cannot be read and no ownership block or decision has been recorded. A recorded block still returns an ownership object with status: unknown when progress cannot be read; retry the read. We manage the paperwork for shared short codes, so this field is always null for them. Other sending requirements can apply even when ownership registration is complete.
Show child attributes
data.ownership.submission_id
string
The most recent ownership submission for this number, including after approval. Users with compliance read access can view the filed answers and their review status from the number's details in the dashboard. This may be a newer filing than the one that cleared the number for use. Absent when no submission was found or submission progress could not be read.
data.ownership.satisfied
boolean
required
Whether the ownership paperwork is accepted or is no longer required. This can remain true while an external verifier asks for a correction or activation is pending. Read status and next for the current step, and blocked_at for the ownership block on outbound SMS and inbound and outbound voice.
data.ownership.status
string
required
Current ownership registration approval status. Operational activation is separate:
blocked_at records the ownership block on number use, and next describes remaining work.
- needs_input means ownership details or a submission correction are needed.
- under_review means your current answers are being reviewed.
- approval_pending means your paperwork is accepted but registration approval is still pending.
- approved means ownership registration is approved. Number activation can still be pending while blocked_at is non-null.
- not_required means no active ownership requirement applies, including after a requirement is withdrawn.
- rejected means the submission was closed or the verifier correction deadline passed. Corrections are no longer accepted for this submission.
- unknown means current approval status could not be determined. Read blocked_at for any recorded ownership block. Retry the read.
Possible values: needs_input, under_review, approval_pending, approved, not_required, rejected, unknown
data.ownership.blocked_at
nullable string
When ownership requirements began blocking outbound SMS and inbound and outbound voice calls. Null when that block is clear. Accepted paperwork can still await activation with a block in place. A number bought before ownership requirements were introduced can have outstanding paperwork without a block.
data.ownership.next
array of object
required
Actions that advance ownership registration or activation, in order. Empty when neither needs further action. A wait step means no customer action is needed now, including while accepted paperwork awaits activation. Read this list again after each change.
Show child attributes
data.ownership.next.kind
string
required
What you do about this step.
- operation: call the operation named in operation, then read again.
- external: act somewhere this API does not reach, then read again.
- wait: nothing is asked of you, so read again later.
- terminal: nothing you do resolves this, so stop retrying.
Tolerate a value you do not recognize: show the description and
offer no action.
Possible values (may grow over time): operation, external, wait, terminal
data.ownership.next.description
string
required
A short, human-readable label for the step, suitable for display.
data.ownership.next.operation
string
The operationId to call. Present only when kind is operation. The operation's own schema says how to call it; this says only which one, and what to address it with.
data.ownership.next.params
object
The parameters that address the operation, by name: {"sender_id": "…"} for an operation on /v1/sms/senders/{sender_id}/requirements. A parameter the operation takes in its query string is given the same way, so an operation addressed as ?subject_id= carries {"subject_id": "…"}. Every parameter the call needs is here, whether its value came from the thing you were acting on or is fixed for this step, so you can make the call from this object alone. Present only when kind is operation and the operation names a subject. A request body, when the operation takes one, is described by the operation's own schema and never appears here.
data.ownership.next.url
string
A URL to open. Present only when kind is external, and only when the step has one. An external step whose description says to go and do something with no URL to open is normal.
next_cursor
nullable string
required
Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursor
nullable string
required
Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursor
nullable string
required
Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
Related resources
Continue with the documentation, guides and examples for this topic.