v1

latestOpenAPI 3.0.02026-07-2633090.6 KB
workspace

Get Workspace Numbers

Retrieves a list of available phone numbers in your workspace.

get/workspace/numbers

Query parameters

limitinteger
Example:50

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

offsetinteger
Example:20

Number of items to skip (default: 0).

Headers

X-API-KEYstring required
Example:7251cb4b-3373-43a4-844c-b27a1d45e0c9

(Required) Your Ringg AI API key.

Response

Successful Response: A list of available phone numbers.

Example response

{
  "workspace_numbers": [
    {
      "id": "5d7f9a2b-1c3e-4f6a-8b9c-0d1e2f3a4b5c",
      "number": "+1234567890",
      "created_at": "2024-12-16T13:03:29.947147+00:00",
      "agent": {
        "id": "830f767a-397e-4b39-82ff-235cd344e2f9",
        "agent_display_name": "Sales Assistant"
      },
      "is_inbound_enabled": true,
      "tags": [],
      "provider": "twilio",
      "display_name": "Sales Line",
      "owner": "demo@ringg.ai",
      "telephony_id": "0b84b167-2dcb-4bbd-abab-1837000bea17",
      "number_pool_id": "0b84b167-2dcb-4bbd-abab-1837000bea17"
    }
  ]
}