Zoom Public API Documentation
List user's contacts
GET {{baseUrl}}/chat/users/me/contacts?type=company&page_size=10&next_page_token=<string>
A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a contact. Call this API to list all the contacts of a Zoom user. Zoom contacts are categorized into Note: This API only supports user-managed OAuth app.company contacts
and external contacts
. You must specify the contact type in the type query parameter. If you do not specify, by default, the type will be set as company contact.
Scope: chat_contact:read
Rate Limit Label: Medium
Body
PARAM
| Key | Datatype | Required | Description |
type
|
string | The type of contact. The value can be one of the following: `company`: Contacts from the user's organization. `external`: External contacts. | |
page_size
|
number | The number of records returned with a single API call. | |
next_page_token
|
string | 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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"contacts": [
{
"email": "<email>",
"first_name": "<string>",
"id": "<string>",
"member_id": "<string>",
"last_name": "<string>"
},
{
"email": "<email>",
"first_name": "<string>",
"id": "<string>",
"member_id": "<string>",
"last_name": "<string>"
}
],
"next_page_token": "<string>",
"page_size": 30
} |
Curl
curl -X GET 'https://api.zoom.us/v2/chat/users/me/contacts?type=company&page_size=10&next_page_token=<string>?type=company&page_size=10&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS