Account API

Retrieve information about accounts.

Get account data by ID

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

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | number

The account ID

123456 None

View response field descriptions

Response Fields

Field Description
page_size
number

Number of records per page

page
number

Current page number

total_pages
number

Total number of pages

total_items
number

Total number of records

_embedded
object

Account object

Field Description
data
object
Field Description
id
number

Unique identifier of the account

name
string

Name of the account

status
string

Status of the account

address
object
Field Description
address_1
string

Street portion of the address

address_2
string

Additional address information

country
string

Country code

state
string

State/Province code

city
string

City name

postal_code
string

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": 123456,
      "name": "Vonage",
      "status": "ACTIVE",
      "address": {
        "address_1": "123 Example Street",
        "address_2": "Apt. 456",
        "country": "US",
        "state": "NJ",
        "city": "Holmdel",
        "postal_code": "07733"
      }
    }
  }
}
Account not found

Get account locations data by account ID

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

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | number

The account ID

123456 None

View response field descriptions

Response Fields

Field Description
page_size
number
page
number
total_pages
number
total_items
number
_embedded
object

Collection of location objects

Field Description
data
array of objects
Field Description
id
number

Unique identifier of the location

name
string

Name of the location

address
object
Field Description
address_1
string

Street portion of the address

address_2
string

Additional address information

country
string

Country code

state
string

State/Province code

city
string

City name

postal_code
string

Postal code

time_zone
string

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": 123456,
        "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

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

Authentication

Key Description Example Default
Authorization Your OAuth token.
Read more about OAuth tokens
Bearer <access_token> None

Path Parameters

Key Description Example Default
account_id
Required | number

The account ID

123456 None
location_id
Required | number

The location ID

123456 None

View response field descriptions

Response Fields

Field Description
page_size
number

Number of records per page

page
number

Current page number

total_pages
number

Total number of pages

total_items
number

Total number of records

_embedded
object

Location object

Field Description
data
object
Field Description
id
number

Unique identifier of the location

name
string

Name of the location

address
object
Field Description
address_1
string

Street portion of the address

address_2
string

Additional address information

country
string

Country code

state
string

State/Province code

city
string

City name

postal_code
string

Postal code

time_zone
string

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": 123456,
      "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"
      }
    }
  }
}
Location not found