The GET /addresses
endpoint gets a list of all addresses within the VCC account.
Only PSTN addresses are returned by this endpoint. API addresses are excluded. |
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
Scope | Access granted |
---|---|
users:read | Entire endpoint |
users:write | Entire endpoint |
The endpoint accepts the following query parameters:
limit
Type | Required | Example |
---|---|---|
integer | False | 25 |
The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.
page
Type | Required | Example |
---|---|---|
integer | False | 1 |
The required page. Minimum of 1, maximum of 1000000000. Default is 1.
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/addresses" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" |
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/addresses?page=2" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" |
Responses contain a list of all addresses within the VCC account.
Successful requests return a 200 Success
code and a collection of addresses.
{ "meta": { "page": 1, "count": 2, "pageCount": 1, "totalCount": 2 }, "addresses": [ { "addressId": "441234567890" }, { "addressId": "441234567899" } ] } |
where:
addresses
. A collection of addresses.addressId
. The unique ID of the address.