The GET /accounts
endpoint gets a list of all VCC accounts that are linked to requesting user.
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
...
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.
Requests
Request all addresses
Code Block | ||||
---|---|---|---|---|
| ||||
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/accounts" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" |
Request second page of addresses
Code Block | ||||
---|---|---|---|---|
| ||||
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/accounts?page=2" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" |
Responses
Responses contain a list of all addresses within the VCC account.
Successful response
Successful requests return a 200 Success
code and a collection of linked VCC accounts.
Example response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "meta": { "page": 1, "count": 2, "pageCount": 1, "totalCount": 2 }, "accounts": [ { "accountName": "Account1", "accountGuid": "ad2bfa1f-b935-4c75-9ec7-f0e9ce6b6cee" }, { "accountName": "Account2", "accountGuid": "254ee84d-dc0a-459c-9bb8-06e208605eff" } ] } |
where:
accounts
. A collection of accounts.accountName
. The name of the account.accountGuid
. The globally unique identifier of the account.
Insert excerpt _ExcerptRunInPostman _ExcerptRunInPostman nopanel true