List external contacts

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

Lists the external contacts.

Prerequisites:

  • Pro or a higher account with Zoom Phone license
  • Account owner or admin permissions

Scopes: phone:read:admin

Granular Scopes: phone:read:list_external_contacts:admin

Rate Limit Label : Light

Request Params

| Key | Datatype | Required | Description | | 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. | | page_size | number | | The number of records returned within a single API call. |

HEADERS

| Key | Datatype | Required | Description | | Accept | string | | |

RESPONSES

status: OK

{&quot;external_contacts&quot;:[{&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;extension_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;external_contact_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;phone_numbers&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;auto_call_recorded&quot;:&quot;\u003cboolean\u003e&quot;},{&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;email&quot;:&quot;\u003cstring\u003e&quot;,&quot;extension_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;external_contact_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;phone_numbers&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;auto_call_recorded&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;next_page_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;page_size&quot;:&quot;\u003cinteger\u003e&quot;}