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: contact_center_contact:read:admin
Rate Limit Label: MEDIUM
Request Params
| 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":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e","contacts":[{"contact_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","phone_numbers":["\u003cstring\u003e","\u003cstring\u003e"],"emails":["\u003cemail\u003e","\u003cemail\u003e"],"location":"\u003cstring\u003e","account_number":"\u003cstring\u003e","company":"\u003cstring\u003e","role":"\u003cstring\u003e","address_book_id":"\u003cstring\u003e","address_book_name":"\u003cstring\u003e","variables":[{"variable_group_id":"\u003cstring\u003e","variable_id":"\u003cstring\u003e","variable_name":"\u003cstring\u003e","data_type":"string","variable_value":"\u003cstring\u003e"},{"variable_group_id":"\u003cstring\u003e","variable_id":"\u003cstring\u003e","variable_name":"\u003cstring\u003e","data_type":"boolean","variable_value":"\u003cstring\u003e"}]},{"contact_id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","phone_numbers":["\u003cstring\u003e","\u003cstring\u003e"],"emails":["\u003cemail\u003e","\u003cemail\u003e"],"location":"\u003cstring\u003e","account_number":"\u003cstring\u003e","company":"\u003cstring\u003e","role":"\u003cstring\u003e","address_book_id":"\u003cstring\u003e","address_book_name":"\u003cstring\u003e","variables":[{"variable_group_id":"\u003cstring\u003e","variable_id":"\u003cstring\u003e","variable_name":"\u003cstring\u003e","data_type":"string","variable_value":"\u003cstring\u003e"},{"variable_group_id":"\u003cstring\u003e","variable_id":"\u003cstring\u003e","variable_name":"\u003cstring\u003e","data_type":"boolean","variable_value":"\u003cstring\u003e"}]}]}