Search company contacts

GET {{baseUrl}}/contacts?search_key=<string>&query_presence_status=<boolean>&page_size=1&contact_types=1&user_status=inactive&next_page_token=<string>

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

Request Params

• 1 — A Zoom user.
• 2 — An auto receptionist.
• 3 — A common area phone.
• 4 — A call queue.
• 5 — A shared line group.
• 6 — A shared global directory.
• 7 — A shared office contact.
• 8 — A ZOOM Room.

Note:

• You must have a phone management role with the "View" permission to query the 2, 3, 4, 5, and 7 values.
• You must provide a valid search_key value to query this parameter. | | user_status | string | | The Zoom user's status:
• active — The user exists on the account.
• inactive — The user has been deactivated.

This value only work for the contact_types field is 1, if not provide all users can be search. | | 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

RESPONSES

status: OK

{"contacts":[{"contact_type":4,"dept":"\u003cstring\u003e","direct_numbers":["\u003cstring\u003e","\u003cstring\u003e"],"email":"\u003cstring\u003e","extension_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","member_id":"\u003cstring\u003e","im_group_id":"\u003cstring\u003e","im_group_name":"\u003cstring\u003e","job_title":"\u003cstring\u003e","last_name":"\u003cstring\u003e","location":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","phone_numbers":[{"code":"\u003cstring\u003e","country":"\u003cstring\u003e","label":"Office","number":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},{"code":"\u003cstring\u003e","country":"\u003cstring\u003e","label":"Mobile","number":"\u003cstring\u003e","verified":"\u003cboolean\u003e"}],"presence_status":"Do_Not_Disturb","user_status":"active","activity":"Unknown","sip_phone_number":"\u003cstring\u003e","sip_uri":"\u003cstring\u003e"},{"contact_type":7,"dept":"\u003cstring\u003e","direct_numbers":["\u003cstring\u003e","\u003cstring\u003e"],"email":"\u003cstring\u003e","extension_number":"\u003cstring\u003e","display_name":"\u003cstring\u003e","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","member_id":"\u003cstring\u003e","im_group_id":"\u003cstring\u003e","im_group_name":"\u003cstring\u003e","job_title":"\u003cstring\u003e","last_name":"\u003cstring\u003e","location":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","phone_numbers":[{"code":"\u003cstring\u003e","country":"\u003cstring\u003e","label":"Mobile","number":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},{"code":"\u003cstring\u003e","country":"\u003cstring\u003e","label":"Home","number":"\u003cstring\u003e","verified":"\u003cboolean\u003e"}],"presence_status":"Available","user_status":"active","activity":"Inactive","sip_phone_number":"\u003cstring\u003e","sip_uri":"\u003cstring\u003e"}],"next_page_token":"\u003cstring\u003e","page_size":"\u003cinteger\u003e"}