User API

Retrieve information about users.

Get account users data by account ID

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

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 | string

The account ID

123456 None

Query Parameter

Key Description Example Default
page_size
number

Number of records per page

10 None
page
number

Current page number

10 None
first_name
string

Filter by first name

John None
last_name
string

Filter by last name

Smith None
login_name
string

Filter by login name

jsmith None
email
string

Filter by email address

john.smith@example.com 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
Field Description
data
array of objects
Field Description
email
string

Email address of the user

login_name
string

Login name of the user

first_name
string

First name of the user

last_name
string

Last name of the user

id
number

Unique identifier of the user

contact_numbers
array of objects

Collection of contact objects

Field Description
type
string

Contact type

value
string

Contact value

extensions
array of objects

Collection of extension objects

Field Description
dids
array of objects

Collection of phone numbers assigned to the extension

Field Description
phone_number
string

Phone number

custom_tag
string

Custom tag associated with the phone number

extension_number
string

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"
    }
  },
  "_embedded": {
    "data": [
      {
        "email": "john.smith@example.com",
        "login_name": "jsmith",
        "first_name": "John",
        "last_name": "Smith",
        "id": 1234567,
        "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 user data by account ID and user ID

GET https://api.vonage.com/t/vbc.prod/provisioning/api/accounts/:account_id/users/:user_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 | string

The account ID

123456 None
user_id
Required | number

The ID of the user

None 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
Field Description
data
object
Field Description
email
string

Email address of the user

login_name
string

Login name of the user

first_name
string

First name of the user

last_name
string

Last name of the user

id
number

Unique identifier of the user

contact_numbers
array of objects

Collection of contact objects

Field Description
type
string

Contact type

value
string

Contact value

extensions
array of objects

Collection of extension objects

Field Description
dids
array of objects

Collection of phone numbers assigned to the extension

Field Description
phone_number
string

Phone number

custom_tag
string

Custom tag associated with the phone number

extension_number
string

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"
    }
  },
  "_embedded": {
    "data": {
      "email": "john.smith@example.com",
      "login_name": "jsmith",
      "first_name": "John",
      "last_name": "Smith",
      "id": 1234567,
      "contact_numbers": [
        {
          "type": "Home",
          "value": "14155550100"
        }
      ],
      "extensions": [
        {
          "dids": [
            {
              "phone_number": "14155550100",
              "custom_tag": "My Tag"
            }
          ],
          "extension_number": "789"
        }
      ]
    }
  }
}
{
  "msg": "abc123",
  "status": 1
}