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: 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 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":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e","address_books":[{"address_book_id":"\u003cstring\u003e","address_book_name":"\u003cstring\u003e","address_book_description":"\u003cstring\u003e","total_contacts":"\u003cinteger\u003e","unit_id":"\u003cstring\u003e","unit_name":"\u003cstring\u003e"},{"address_book_id":"\u003cstring\u003e","address_book_name":"\u003cstring\u003e","address_book_description":"\u003cstring\u003e","total_contacts":"\u003cinteger\u003e","unit_id":"\u003cstring\u003e","unit_name":"\u003cstring\u003e"}]}