GET contacts

zoom.us

Summary: Search company contacts
Operation ID: searchCompanyContacts
Auth: unknown
Description

A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. Use this API to search users that are in the company contacts of a Zoom account. Using the `search_key` query parameter, provide either first name, last name or the email address of the user that you would like to search for. Optionally, set `query_presence_status` to `true` in order to include the presence status of a contact. <br><br> **Scopes:** `contact:read:admin`, `contact:read`<br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`

Parameters (4)

next_page_token (string, query, optional)

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

page_size (integer, query, optional, default: 1)

The number of records to be returned with a single API call.

Constraints: {'maximum': 25}

query_presence_status (string, query, optional)

Set `query_presence_status` to `true` in order to include the presence status of a contact in the response.

search_key (string, query, required)

Provide the keyword - either first name, last name or email of the contact whom you have to search for.

No probe data for this endpoint yet.