Zoom Public API Documentation
List address books
GET {{baseUrl}}/contact_center/address_books?next_page_token=<string>&page_size=30&unit_id=<string>
Use this API to return all address books. Scopes: Rate Limit Label: contact_center_contact:read:adminMedium
Body
PARAM
| Key | Datatype | Required | Description |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token returns whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size
|
number | The number of items returned per page. | |
unit_id
|
string | (Required) The address book unit's ID. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"total_records": "<integer>",
"address_books": [
{
"address_book_id": "<string>",
"address_book_name": "<string>",
"address_book_description": "<string>",
"total_contacts": "<integer>",
"unit_id": "<string>",
"unit_name": "<string>"
},
{
"address_book_id": "<string>",
"address_book_name": "<string>",
"address_book_description": "<string>",
"total_contacts": "<integer>",
"unit_id": "<string>",
"unit_name": "<string>"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/address_books?next_page_token=<string>&page_size=30&unit_id=<string>?next_page_token=<string>&page_size=30&unit_id=<string>' -H 'Accept: application/json'
ENDPOINTS