Logo
Zoom Public API Documentation

List shared line appearances

GET {{baseUrl}}/phone/shared_line_appearances?page_size=30&next_page_token=<string>

Use this API to list shared line appearance instances.

Prerequisites: * Pro or higher account with Zoom Phone license * Account owner or admin privileges

Scopes: phone:read:admin

Granular Scopes: phone:read:list_shared_line_appearances:admin

Rate Limit Label: Medium

 

Body PARAM

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.



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

status OK

{ "next_page_token": "<string>", "page_size": 30, "shared_line_appearances": [ { "executive": { "name": "<string>", "extension_number": "<long>", "extension_type": "user" }, "assistants": [ { "id": "<string>", "name": "<string>", "extension_number": "<long>", "extension_type": "commonArea" }, { "id": "<string>", "name": "<string>", "extension_number": "<long>", "extension_type": "commonArea" } ], "privileges": [ "answer_calls", "place_calls" ] }, { "executive": { "name": "<string>", "extension_number": "<long>", "extension_type": "user" }, "assistants": [ { "id": "<string>", "name": "<string>", "extension_number": "<long>", "extension_type": "user" }, { "id": "<string>", "name": "<string>", "extension_number": "<long>", "extension_type": "commonArea" } ], "privileges": [ "answer_calls", "answer_calls" ] } ], "total_records": "<integer>" }



Curl
curl -X GET 'https://api.zoom.us/v2/phone/shared_line_appearances?page_size=30&next_page_token=<string>?page_size=30&next_page_token=<string>' -H 'Accept: application/json'

ENDPOINTS