List phone numbers

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

Pagination Options:

1. 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.

2. 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.

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 [e-mail] 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

200

application/json

Successfully retrieved phone numbers

data · Data · array · required

List of phone number objects matching the query criteria.

PSTN Phone Number

Show child attributes

message · string · default: Calls retrieved successfully

Response message indicating the status of the request.

error · object | null

Show child attributes

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