Skip to main content
GET
/
v1
/
phone-numbers
List phone numbers
curl --request GET \
  --url https://api.callrounded.com/v1/phone-numbers \
  --header 'X-Api-Key: <api-key>'
{
  "message": "Calls retrieved successfully",
  "data": [
    {
      "type": "pstn",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "number": "<string>",
      "name": "<string>",
      "inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "redirect": true,
      "redirect_phone_number": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "error": {
    "details": [
      {
        "field": "email",
        "message": "Invalid email format"
      }
    ],
    "message": "An error occurred while processing your request",
    "status": 400,
    "type": "generic_error"
  },
  "status": 200,
  "next_cursor": "<string>",
  "current_page": 123,
  "total_pages": 123,
  "total_items": 123
}

Authorizations

​
X-Api-Key
string
header
required

The API Key created in Rounded Studio.

Query Parameters

​
page
integer
default:1

Page number for page-based pagination (1-indexed, by default or when use_cursor=false).

​
limit
integer | null
default:50

Maximum number of results to return per page (default: 50, max: 1000).

​
use_cursor
boolean | null
default:false

Pagination mode selection: true for cursor-based pagination, false for page-based pagination.

​
cursor
string | null

Cursor for pagination based on the phone number created_at property (ISO 8601 datetime of last seen record).

Response

Successfully retrieved phone numbers

​
data
Data · array
required

List of phone number objects matching the query criteria.

  • PSTN Phone Number
  • SIP Phone Number
​
message
string
default:Calls retrieved successfully

Response message indicating the status of the request.

​
error
object | null
Example:
{
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ],
  "message": "An error occurred while processing your request",
  "status": 400,
  "type": "generic_error"
}
​
status
integer
default:200

HTTP status code (200 for successful requests).

​
next_cursor
string | null

Next cursor value for cursor-based pagination (ISO 8601 datetime string, only present when use_cursor=true).

​
current_page
integer | null

Current page number (by default or when use_cursor=false).

​
total_pages
integer | null

Total number of pages available (by default or when use_cursor=false).

​
total_items
integer | null

Total count of items matching the query criteria (by default or when use_cursor=false).

⌘I