GET /contacts
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.
Scopes: contact:read:admin, contact:read
Rate Limit Label: Medium
Servers
- https://api.zoom.us/v2
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
search_key |
String | Yes |
Provide the keyword - either first name, last name or email of the contact whom you have to search for. |
page_size |
Integer | No |
The number of records to be returned with a single API call. Default value: 1 |
next_page_token |
String | No |
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. |
query_presence_status |
String | No |
Set |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.