List group call pickup objects
GET {{baseUrl}}/phone/group_call_pickup?page_size=30&next_page_token=<string>&site_id=<string>
Use this API to retrieve a list of Group Call Pickup objects in an account.
Prerequisites:
- A Pro or higher account plan
- A Zoom Phone license
Scopes:
phone:read:admin
Granular Scopes:
phone:read:list_call_pickup_groups:admin
Rate Limit Label
:
Medium
Request Params
| Key | Datatype | Required | Description |
| page_size | number | | The number of records returned within a single API call. |
| next_page_token | string | | The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. |
| site_id | string | | Unique identifier of the site. This can be retrieved from the List Phone Sites API. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | |
RESPONSES
status: OK
{"group_call_pickup":[{"id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","member_count":"\u003cinteger\u003e","description":"\u003cstring\u003e","delay":10,"cost_center":"\u003cstring\u003e","department":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"directed_call_pickup":"\u003cboolean\u003e"},{"id":"\u003cstring\u003e","display_name":"\u003cstring\u003e","extension_id":"\u003cstring\u003e","extension_number":"\u003clong\u003e","member_count":"\u003cinteger\u003e","description":"\u003cstring\u003e","delay":10,"cost_center":"\u003cstring\u003e","department":"\u003cstring\u003e","site":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e"},"directed_call_pickup":"\u003cboolean\u003e"}],"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e","total_records":"\u003cinteger\u003e"}