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 of records per page

page

Current page number

total_pages

Total number of pages

total_items

Total number of records

_embedded

Account object

Field Description
data
Field Description
id

Unique identifier of the account

name

Name of the account

status

Status of the account

address
Field Description
address_1

Street portion of the address

address_2

Additional address information

country

Country code

state

State/Province code

city

City name

postal_code

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"
      }
    }
  }
}
No content

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
page
total_pages
total_items
_embedded

Collection of location objects

Field Description
data
array of objects
Field Description
id

Unique identifier of the location

name

Name of the location

address
Field Description
address_1

Street portion of the address

address_2

Additional address information

country

Country code

state

State/Province code

city

City name

postal_code

Postal code

time_zone

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 of records per page

page

Current page number

total_pages

Total number of pages

total_items

Total number of records

_embedded

Location object

Field Description
data
Field Description
id

Unique identifier of the location

name

Name of the location

address
Field Description
address_1

Street portion of the address

address_2

Additional address information

country

Country code

state

State/Province code

city

City name

postal_code

Postal code

time_zone

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"
      }
    }
  }
}
No content