Skip to main content
GET
/
workspace
/
numbers
Get Workspace Numbers
curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/workspace/numbers \
  --header 'X-API-KEY: <x-api-key>'
{
  "workspace_numbers": [
    {
      "id": "5d7f9a2b-1c3e-4f6a-8b9c-0d1e2f3a4b5c",
      "number": "+1234567890",
      "created_at": "2024-12-16T13:03:29.947147+00:00",
      "call_count": 0,
      "agent": {
        "id": "830f767a-397e-4b39-82ff-235cd344e2f9",
        "agent_display_name": "Sales Assistant"
      },
      "is_inbound_enabled": true,
      "is_test_number": false,
      "tags": [],
      "is_spam": false,
      "spam_message": null,
      "provider": "twilio",
      "display_name": "Sales Line",
      "owner": "demo@ringg.ai",
      "is_custom_number": false,
      "telephony_id": "0b84b167-2dcb-4bbd-abab-1837000bea17",
      "number_pool_id": "0b84b167-2dcb-4bbd-abab-1837000bea17"
    }
  ]
}
List phone numbers available in the workspace. Outbound calls and campaigns use these numbers as caller IDs. Inbound assistants use assigned numbers as the numbers users dial.

​
When to use

  • Populate a caller-number selector before starting calls.
  • Find the from_number_id for POST /calling/outbound/individual.
  • Confirm imported BYOT numbers are available after telephony setup.

​
Integration notes

  • Store the selected from_number_id alongside your assistant or campaign configuration.
  • Numbers must be provisioned, imported, or assigned in the Ringg workspace before they can be used.
  • For campaigns, pass selected numbers in from_numbers.

Headers

​
X-API-KEY
string
required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Query Parameters

​
limit
integer
default:10

Number of items to return (default: 20, max: 100).

Example:

50

​
offset
integer
default:0

Number of items to skip (default: 0).

Example:

20

Response

Successful Response: A list of available phone numbers.

​
workspace_numbers
object[]