List phone numbers

curl --request GET \
  --url https://api.callrounded.com/v1/phone-numbers \
  --header 'X-Api-Key: <api-key>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "number": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "type": "pstn",
      "inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "redirect": false,
      "redirect_phone_number": "<string>"
    }
  ],
  "message": "Calls retrieved successfully",
  "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
}

phone-numbers

List phone numbers

List phone numbers with pagination. The response includes headers about rate limiting.

Pagination Options:

Page-based pagination (default):
- Provide page and limit parameters.
- Response includes current_page, total_pages, and total_items.
- Best for UIs that need to jump to specific pages.
Cursor-based pagination:
- Based on phone number created_at property (ISO 8601 datetime of last seen record).
- Set use_cursor=true.
- Provide limit parameter to control results per page (default: 50, max: 1000).
- Response includes next_cursor for subsequent requests.
- Best for efficiently paging through large datasets.

GET

phone-numbers

List phone numbers

curl --request GET \
  --url https://api.callrounded.com/v1/phone-numbers \
  --header 'X-Api-Key: <api-key>'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "number": "<string>",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "type": "pstn",
      "inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "redirect": false,
      "redirect_phone_number": "<string>"
    }
  ],
  "message": "Calls retrieved successfully",
  "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.

You can create it by going to the "API Keys" settings of your profile.
Need help? You can email us at [email protected] or join our Discord community.

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

(PSTN Phone Number · object | SIP Phone Number · object)[]

required

List of phone number objects matching the query criteria.

PSTN Phone Number
SIP Phone Number

Show child attributes

data.id

string<uuid>

required

The ID of the phone number.

data.number

string

required

The phone number.

data.name

string

required

The phone number friendly name.

data.created_at

string<date-time>

required

The date and time the phone number was created.

data.type

string

default:pstn

Allowed value: "pstn"

data.inbound_agent_id

string<uuid> | null

The agent ID that will handle incoming calls to this phone number.

data.redirect

boolean | null

default:false

Whether to redirect the phone number. If true, any calls to this phone number will be redirected to the redirect_phone_number overriding the agent assignment.

data.redirect_phone_number

string | null

The phone number to redirect to.

message

string

default:Calls retrieved successfully

Response message indicating the status of the request.

error

ApiResponseError · object

Show child attributes

error.message

string

required

error.type

string

required

error.status

integer

required

error.details

ApiResponseErrorDetail · object[] | null

Show child attributes

error.details.message

string

required

error.details.field

string | 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).

Deploy agent Update phone number

⌘I

calls

knowledge bases

agents

phone-numbers

List phone numbers

Authorizations

Query Parameters

Response