v1

latestOpenAPI 3.0.02026-07-142177.1 KB

Get account users data by account ID

get/api/accounts/{account_id}/users

Path parameters

account_idstring required

The Vonage Business Cloud account ID

Query parameters

page_sizenumber

Number of records per page

pagenumber

Current page number

first_namestring

Filter by first name

last_namestring

Filter by last name

login_namestring

Filter by login name

emailstring

Filter by email address

Response

Success

pagenumber

Current page number

page_sizenumber

Number of records per page

total_itemsnumber

Total number of records

total_pagesnumber

Total number of pages

Example response

{
  "_embedded": {
    "data": [
      {
        "contact_numbers": [
          {
            "type": "Home",
            "value": "14155550100"
          }
        ],
        "email": "john.smith@example.com",
        "extensions": [
          {
            "dids": [
              {
                "custom_tag": "My Tag",
                "phone_number": "14155550100"
              }
            ],
            "extension_number": "789"
          }
        ],
        "first_name": "John",
        "id": 869048,
        "last_name": "Smith",
        "login_name": "jsmith"
      }
    ]
  },
  "page": 1,
  "page_size": 10,
  "total_items": 100,
  "total_pages": 10
}
All 2 operations