The Vonage Business Communications Provisioning API enables you to retrieve information about accounts, users and extensions.
Your application must subscribe to the Provisioning API suite to use this API.
GET
https://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id
Host
https://api.vonage.com
GET
/t/vbc.prod/provisioning/api/accounts/:account_id
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID
Number of records per page
Current page number
Total number of pages
Total number of records
Account object
Unique identifier of the account
Name of the account
Status of the account
Street portion of the address
Additional address information
Country code
State/Province code
City name
Postal code
{
"page_size": 100,
"page": 1,
"total_pages": 10,
"total_items": 100,
"_links": {
"first": {
"href": "abc123"
},
"prev": {
"href": "abc123"
},
"self": {
"href": "abc123"
},
"next": {
"href": "abc123"
},
"last": {
"href": "abc123"
}
},
"_embedded": {
"data": {
"id": 571700,
"name": "Vonage",
"status": "ACTIVE",
"address": {
"address_1": "123 Example Street",
"address_2": "Apt. 456",
"country": "US",
"state": "NJ",
"city": "Holmdel",
"postal_code": "07733"
}
}
}
}This endpoint does not support application/json
GET
https://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/locations
Host
https://api.vonage.com
GET
/t/vbc.prod/provisioning/api/accounts/:account_id/locations
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID
Collection of location objects
Unique identifier of the location
Name of the location
Street portion of the address
Additional address information
Country code
State/Province code
City name
Postal code
Time zone
{
"page_size": 100,
"page": 1,
"total_pages": 10,
"total_items": 100,
"_links": {
"first": {
"href": "abc123"
},
"prev": {
"href": "abc123"
},
"self": {
"href": "abc123"
},
"next": {
"href": "abc123"
},
"last": {
"href": "abc123"
}
},
"_embedded": {
"data": [
{
"id": 327910,
"name": "Headquarters",
"address": {
"address_1": "123 Example Street",
"address_2": "Apt. 456",
"country": "US",
"state": "NJ",
"city": "Holmdel",
"postal_code": "07733",
"time_zone": "America/New York"
}
}
]
}
}GET
https://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/locations/:location_id
Host
https://api.vonage.com
GET
/t/vbc.prod/provisioning/api/accounts/:account_id/locations/:location_id
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID
The Vonage Business Communications location ID
Number of records per page
Current page number
Total number of pages
Total number of records
Location object
Unique identifier of the location
Name of the location
Street portion of the address
Additional address information
Country code
State/Province code
City name
Postal code
Time zone
{
"page_size": 100,
"page": 1,
"total_pages": 10,
"total_items": 100,
"_links": {
"first": {
"href": "abc123"
},
"prev": {
"href": "abc123"
},
"self": {
"href": "abc123"
},
"next": {
"href": "abc123"
},
"last": {
"href": "abc123"
}
},
"_embedded": {
"data": {
"id": 327910,
"name": "Headquarters",
"address": {
"address_1": "123 Example Street",
"address_2": "Apt. 456",
"country": "US",
"state": "NJ",
"city": "Holmdel",
"postal_code": "07733",
"time_zone": "America/New York"
}
}
}
}This endpoint does not support application/json
GET
https://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/extensions
Host
https://api.vonage.com
GET
/t/vbc.prod/provisioning/api/accounts/:account_id/extensions
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID
Number of records per page
Current page number
Filter by location id
Filter by phone number
Filter by login name
Filter by email address
Number of records per page
Current page number
Total number of pages
Total number of records
Extension number
Unique ID of the user
Email address of the user
Login name of the user
First name of the user
Last name of the user
Unique identifier of the assigned location
Voicemail transcription status of the location
Do Not Disturb status of the extension
Caller ID of the extension
The unique identifier of the extension
Block Caller ID status of the extension
Collection of phone numbers assigned to the extension
Phone number
Custom tag associated with the phone number
Collection of handsets assigned to the extension
Name of the handset
SIP identifier of the handset
{
"page_size": 10,
"page": 1,
"total_pages": 10,
"total_items": 100,
"_links": {
"first": {
"href": "abc123"
},
"prev": {
"href": "abc123"
},
"self": {
"href": "abc123"
},
"next": {
"href": "abc123"
},
"last": {
"href": "abc123"
}
},
"_embedded": {
"data": {
"extension_number": "789",
"user": {
"id": 2111111,
"email": "john.smith@example.com",
"login_name": "jsmith",
"first_name": "John",
"last_name": "Smith"
},
"location_id": 145214,
"vtt_enabled": true,
"dnd_enabled": false,
"caller_id": "John Smith",
"external_id": "abc11111111111",
"block_caller_id": false,
"dids": [
{
"phone_number": "14155550100",
"custom_tag": "My Tag"
}
],
"extension_handsets": [
{
"handset_name": "line1-VH6370927",
"sip_id": "VH16370927"
}
]
}
}
}{
"status": 1,
"title": "abc123",
"instance": "abc123",
"invalid_parameters": [
{
"name": "abc123",
"reason": "abc123"
}
]
}GET
https://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/extensions/:external_id
Host
https://api.vonage.com
GET
/t/vbc.prod/provisioning/api/accounts/:account_id/extensions/:external_id
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID
The unique id of the extension
Extension number
Unique ID of the user
Email address of the user
Login name of the user
First name of the user
Last name of the user
Unique identifier of the assigned location
Voicemail transcription status of the location
Do Not Disturb status of the extension
Caller ID of the extension
The unique identifier of the extension
Service type name of the extension
Block Caller ID status of the extension
Collection of phone numbers assigned to the extension
Phone number
Custom tag associated with the phone number
Collection of handsets assigned to the extension
Name of the handset
SIP identifier of the handset
{
"_links": {
"self": {
"href": "abc123"
}
},
"_embedded": {
"extension": {
"extension_number": "789",
"user": {
"id": 2111111,
"email": "john.smith@example.com",
"login_name": "jsmith",
"first_name": "John",
"last_name": "Smith"
},
"location_id": 145214,
"vtt_enabled": true,
"dnd_enabled": false,
"caller_id": "John Smith",
"external_id": "abc11111111111",
"service_type_name": "UX",
"block_caller_id": false,
"dids": [
{
"phone_number": "14155550100",
"custom_tag": "My Tag"
}
],
"extension_handsets": [
{
"handset_name": "line1-VH6370927",
"sip_id": "VH16370927"
}
]
}
}
}{
"msg": "abc123",
"status": 1
}GET
https://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/users
Host
https://api.vonage.com
GET
/t/vbc.prod/provisioning/api/accounts/:account_id/users
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID
Number of records per page
Current page number
Filter by first name
Filter by last name
Filter by login name
Filter by email address
Number of records per page
Current page number
Total number of pages
Total number of records
Email address of the user
Login name of the user
First name of the user
Last name of the user
Unique identifier of the user
Collection of contact objects
Contact type
Contact value
Collection of extension objects
Collection of phone numbers assigned to the extension
Phone number
Custom tag associated with the phone number
Extension number
{
"page_size": 10,
"page": 1,
"total_pages": 10,
"total_items": 100,
"_links": {
"first": {
"href": "abc123"
},
"prev": {
"href": "abc123"
},
"self": {
"href": "abc123"
},
"next": {
"href": "abc123"
},
"last": {
"href": "abc123"
}
},
"_embedded": {
"data": [
{
"email": "john.smith@example.com",
"login_name": "jsmith",
"first_name": "John",
"last_name": "Smith",
"id": 869048,
"contact_numbers": [
{
"type": "Home",
"value": "14155550100"
}
],
"extensions": [
{
"dids": [
{
"phone_number": "14155550100",
"custom_tag": "My Tag"
}
],
"extension_number": "789"
}
]
}
]
}
}{
"status": 1,
"title": "abc123",
"instance": "abc123",
"invalid_parameters": [
{
"name": "abc123",
"reason": "abc123"
}
]
}GET
https://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/users/:user_id
Host
https://api.vonage.com
GET
/t/vbc.prod/provisioning/api/accounts/:account_id/users/:user_id
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your OAuth token. Read more about OAuth tokens |
Bearer <access_token> |
None |
The Vonage Business Communications account ID
The Vonage Business Communications user ID
Number of records per page
Current page number
Total number of pages
Total number of records
Email address of the user
Login name of the user
First name of the user
Last name of the user
Unique identifier of the user
Collection of contact objects
Contact type
Contact value
Collection of extension objects
Collection of phone numbers assigned to the extension
Phone number
Custom tag associated with the phone number
Extension number
{
"page_size": 10,
"page": 1,
"total_pages": 10,
"total_items": 100,
"_links": {
"first": {
"href": "abc123"
},
"prev": {
"href": "abc123"
},
"self": {
"href": "abc123"
},
"next": {
"href": "abc123"
},
"last": {
"href": "abc123"
}
},
"_embedded": {
"data": {
"email": "john.smith@example.com",
"login_name": "jsmith",
"first_name": "John",
"last_name": "Smith",
"id": 869048,
"contact_numbers": [
{
"type": "Home",
"value": "14155550100"
}
],
"extensions": [
{
"dids": [
{
"phone_number": "14155550100",
"custom_tag": "My Tag"
}
],
"extension_number": "789"
}
]
}
}
}{
"msg": "abc123",
"status": 1
}