List SIP Extensions

GET

/pbx/extensions

const url = 'https://pbx.ring2all.com/api/v1/pbx/extensions?page=1&limit=50';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://pbx.ring2all.com/api/v1/pbx/extensions?page=1&limit=50' \
  --header 'X-API-Key: <X-API-Key>'

Returns a paginated list of configured SIP extensions for the authorized tenant domain.

Authorizations

ApiKeyAuth
BearerAuth

Parameters

Query Parameters

page

integer

default: 1

Page number

limit

integer

default: 50

Items per page

search

string

Search by extension number, name, or email

Responses

200

List of extensions

application/json

object

data

Array<object>

object

integer

extension

string

display_name

string

voicemail_enabled

boolean

status

string

Allowed values: registered unregistered

user_agent

string

total

integer

Example

{
  "data": [
    {
      "id": 101,
      "extension": "1001",
      "display_name": "Operations Desk",
      "voicemail_enabled": true,
      "status": "registered",
      "user_agent": "Grandstream GRP2614 1.0.7.23"
    }
  ],
  "total": 124
}