Zoom Public API Documentation
List address book contacts
GET {{baseUrl}}/contact_center/address_books/:addressBookId/contacts?next_page_token=<string>&page_size=30
Return all contacts in an address book. 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 is returned 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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"next_page_token": "<string>",
"page_size": 30,
"total_records": "<integer>",
"contacts": [
{
"contact_id": "<string>",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone_numbers": [
"<string>",
"<string>"
],
"emails": [
"<email>",
"<email>"
],
"location": "<string>",
"account_number": "<string>",
"company": "<string>",
"role": "<string>",
"address_book_id": "<string>",
"address_book_name": "<string>",
"variables": [
{
"variable_group_id": "<string>",
"variable_id": "<string>",
"variable_name": "<string>",
"data_type": "string",
"variable_value": "<string>"
},
{
"variable_group_id": "<string>",
"variable_id": "<string>",
"variable_name": "<string>",
"data_type": "boolean",
"variable_value": "<string>"
}
]
},
{
"contact_id": "<string>",
"display_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"phone_numbers": [
"<string>",
"<string>"
],
"emails": [
"<email>",
"<email>"
],
"location": "<string>",
"account_number": "<string>",
"company": "<string>",
"role": "<string>",
"address_book_id": "<string>",
"address_book_name": "<string>",
"variables": [
{
"variable_group_id": "<string>",
"variable_id": "<string>",
"variable_name": "<string>",
"data_type": "string",
"variable_value": "<string>"
},
{
"variable_group_id": "<string>",
"variable_id": "<string>",
"variable_name": "<string>",
"data_type": "boolean",
"variable_value": "<string>"
}
]
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/contact_center/address_books/:addressBookId/contacts?next_page_token=<string>&page_size=30?next_page_token=<string>&page_size=30' -H 'Accept: application/json'
ENDPOINTS