Skip to main content
GET
Get Workspace Numbers
Each number’s id is the from_number_id that individual calls take as caller ID. Numbers appear here once they are bought or imported in the dashboard (Buy and import numbers). The list is not paged: every matching number comes back in one response, newest first. Filter it with telephony_account_id (a connected telephony account’s ID, or ringg for numbers provided by Ringg, including the shared test numbers) and inbound_enabled (true or false).

Fields to check

object
The agent the number is attached to (id, agent_display_name); inbound calls to the number reach that agent.
boolean
A shared Ringg test number: for testing only, not for live calls or number pools.
boolean
The number has been flagged as spam; spam_message says why. Pick another number, or let a number pool skip it.
string
The number pool the number belongs to, if any.
string
The telephony provider behind the number; ringg for numbers on Ringg’s own account.
string
ringg for a number on Ringg’s account, customer for one on your own telephony account.
boolean
true for a WhatsApp Relay number.

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Query Parameters

telephony_account_id
string

(Optional) A connected telephony account's ID to list only its numbers, or ringg for numbers provided by Ringg, including the shared test numbers. Leave it out for every number.

Example:

"ringg"

inbound_enabled
boolean

(Optional) true for numbers that can receive inbound calls, false for the rest.

Response

Successful Response: A list of available phone numbers.

workspace_numbers
object[]