Provisioning API

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.

Download OpenAPI Specification

Available Operations

Get account data by ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID

Responses
Content Type
application/json

Success

page_size

number

example100

Number of records per page

page

number

example1

Current page number

total_pages

number

example10

Total number of pages

total_items

number

example100

Total number of records

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

Account object

data

object

number

example571700

Unique identifier of the account

name

string

exampleVonage

Name of the account

status

string

exampleACTIVE

Status of the account

address

object

address_1

string

example123 Example Street

Street portion of the address

address_2

string

exampleApt. 456

Additional address information

country

string

exampleUS

Country code

state

string

exampleNJ

State/Province code

city

string

exampleHolmdel

City name

postal_code

string

example07733

Postal code

Example Response

{
   "page_size": 100,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_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"
         }
      }
   }
}

Get account locations data by account ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/locations

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID

Responses
Content Type
application/json

Success

page_size

number

example100

page

number

example1

total_pages

number

example10

total_items

number

example100

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

Collection of location objects

data

array

number

example327910

Unique identifier of the location

name

string

exampleHeadquarters

Name of the location

address

object

address_1

string

example123 Example Street

Street portion of the address

address_2

string

exampleApt. 456

Additional address information

country

string

exampleUS

Country code

state

string

exampleNJ

State/Province code

city

string

exampleHolmdel

City name

postal_code

string

example07733

Postal code

time_zone

string

exampleAmerica/New York

Time zone

Example Response

{
   "page_size": 100,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_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 location data by account ID and location ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/locations/:location_id

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID

location_id

number

Required

The Vonage Business Communications location ID

Responses
Content Type
application/json

Success

page_size

number

example100

Number of records per page

page

number

example1

Current page number

total_pages

number

example10

Total number of pages

total_items

number

example100

Total number of records

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

Location object

data

object

number

example327910

Unique identifier of the location

name

string

exampleHeadquarters

Name of the location

address

object

address_1

string

example123 Example Street

Street portion of the address

address_2

string

exampleApt. 456

Additional address information

country

string

exampleUS

Country code

state

string

exampleNJ

State/Province code

city

string

exampleHolmdel

City name

postal_code

string

example07733

Postal code

time_zone

string

exampleAmerica/New York

Time zone

Example Response

{
   "page_size": 100,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_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 account extensions data by account ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/extensions

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID

Query Parameters

page_size

number

Number of records per page

page

number

Current page number

location_id

number

Filter by location id

phone_number

string

Filter by phone number

login_name

string

Filter by login name

string

Filter by email address

Responses
Content Type
application/json

Success

page_size

number

example10

Number of records per page

page

number

example1

Current page number

total_pages

number

example10

Total number of pages

total_items

number

example100

Total number of records

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

data

object

extension_number

string

example789

Extension number

user

object

number

example2111111

Unique ID of the user

string

examplejohn.smith@example.com

Email address of the user

login_name

string

examplejsmith

first_name

string

exampleJohn

First name of the user

last_name

string

exampleSmith

Last name of the user

location_id

number

example145214

Unique identifier of the assigned location

vtt_enabled

boolean

exampletrue

Voicemail transcription status of the location

dnd_enabled

boolean

Do Not Disturb status of the extension

caller_id

string

exampleJohn Smith

Caller ID of the extension

external_id

string

exampleabc11111111111

The unique identifier of the extension

block_caller_id

boolean

Block Caller ID status of the extension

dids

array

Collection of phone numbers assigned to the extension

phone_number

string

example14155550100

Phone number

custom_tag

string

exampleMy Tag

Custom tag associated with the phone number

extension_handsets

array

Collection of handsets assigned to the extension

handset_name

string

exampleline1-VH6370927

Name of the handset

sip_id

string

exampleVH16370927

SIP identifier of the handset

Example Response

{
   "page_size": 10,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_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"
            }
         ]
      }
   }
}

Get extension data by account ID and extension ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/extensions/:external_id

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID

external_id

number

Required

The unique id of the extension

Responses
Content Type
application/json

Success

_links

object

self

object

URL to the current page of records

href

string

_embedded

object

extension

object

extension_number

string

example789

Extension number

user

object

number

example2111111

Unique ID of the user

string

examplejohn.smith@example.com

Email address of the user

login_name

string

examplejsmith

first_name

string

exampleJohn

First name of the user

last_name

string

exampleSmith

Last name of the user

location_id

number

example145214

Unique identifier of the assigned location

vtt_enabled

boolean

exampletrue

Voicemail transcription status of the location

dnd_enabled

boolean

Do Not Disturb status of the extension

caller_id

string

exampleJohn Smith

Caller ID of the extension

external_id

string

exampleabc11111111111

The unique identifier of the extension

service_type_name

string

exampleUX

Service type name of the extension

block_caller_id

boolean

Block Caller ID status of the extension

dids

array

Collection of phone numbers assigned to the extension

phone_number

string

example14155550100

Phone number

custom_tag

string

exampleMy Tag

Custom tag associated with the phone number

extension_handsets

array

Collection of handsets assigned to the extension

handset_name

string

exampleline1-VH6370927

Name of the handset

sip_id

string

exampleVH16370927

SIP identifier of the handset

Example Response

{
   "_links": {
      "self": {
         "href": "string"
      }
   },
   "_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"
            }
         ]
      }
   }
}

Get account users data by account ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/users

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID

Query Parameters

page_size

number

Number of records per page

page

number

Current page number

first_name

string

Filter by first name

last_name

string

Filter by last name

login_name

string

Filter by login name

string

Filter by email address

Responses
Content Type
application/json

Success

page_size

number

example10

Number of records per page

page

number

example1

Current page number

total_pages

number

example10

Total number of pages

total_items

number

example100

Total number of records

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

data

array

string

examplejohn.smith@example.com

Email address of the user

login_name

string

examplejsmith

first_name

string

exampleJohn

First name of the user

last_name

string

exampleSmith

Last name of the user

number

example869048

Unique identifier of the user

contact_numbers

array

Collection of contact objects

type

string

exampleHome

Contact type

value

string

example14155550100

Contact value

extensions

array

Collection of extension objects

dids

array

Collection of phone numbers assigned to the extension

phone_number

string

example14155550100

Phone number

custom_tag

string

exampleMy Tag

Custom tag associated with the phone number

extension_number

string

example789

Extension number

Example Response

{
   "page_size": 10,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_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"
               }
            ]
         }
      ]
   }
}

Get user data by account ID and user ID

gethttps://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/users/:user_id

Authentication

Key	Description	Where	Example
Authorization	Your OAuth token. Read more about OAuth tokens	Headers	`Bearer <access_token>`

Path Parameters

account_id

string

Required

The Vonage Business Communications account ID

user_id

number

Required

The Vonage Business Communications user ID

Responses
Content Type
application/json

Success

page_size

number

example10

Number of records per page

page

number

example1

Current page number

total_pages

number

example10

Total number of pages

total_items

number

example100

Total number of records

_links

object

first

object

URL to the first page of records

href

string

object

URL to the previous page of records

href

string

self

object

URL to the current page of records

href

string

object

URL to the next page of records

href

string

last

object

URL to the last page of records

href

string

_embedded

object

data

object

string

examplejohn.smith@example.com

Email address of the user

login_name

string

examplejsmith

first_name

string

exampleJohn

First name of the user

last_name

string

exampleSmith

Last name of the user

number

example869048

Unique identifier of the user

contact_numbers

array

Collection of contact objects

type

string

exampleHome

Contact type

value

string

example14155550100

Contact value

extensions

array

Collection of extension objects

dids

array

Collection of phone numbers assigned to the extension

phone_number

string

example14155550100

Phone number

custom_tag

string

exampleMy Tag

Custom tag associated with the phone number

extension_number

string

example789

Extension number

Example Response

{
   "page_size": 10,
   "page": 1,
   "total_pages": 10,
   "total_items": 100,
   "_links": {
      "first": {
         "href": "string"
      },
      "prev": {
         "href": "string"
      },
      "self": {
         "href": "string"
      },
      "next": {
         "href": "string"
      },
      "last": {
         "href": "string"
      }
   },
   "_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"
            }
         ]
      }
   }
}

Provisioning API

Available Operations

Get account data by ID

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Get account locations data by account ID

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Get location data by account ID and location ID

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Get account extensions data by account ID

Authentication

Path Parameters

Query Parameters

Responses Content Typeapplication/json

Example Response

Get extension data by account ID and extension ID

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Get account users data by account ID

Authentication

Path Parameters

Query Parameters

Responses Content Typeapplication/json

Example Response

Get user data by account ID and user ID

Authentication

Path Parameters

Responses Content Typeapplication/json

Example Response

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json

Responses
Content Type
application/json