GET /users/{userId}/token

Retrieve a user's token.

This token is used for starting meetings with the Client SDK.
Scopes: user:read:admin user:read

Rate Limit Label: Light If a user signed into Zoom using Google or Facebook, a null value will be returned for the token. To get the token with this API, ask the user to sign into Zoom using their email and password instead.

Servers

Path parameters

Name Type Required Description
userId String Yes

The user ID or email address of the user. For user-level apps, pass me as the value for userId.

Query parameters

Name Type Required Description
ttl Integer No

Use this field in conjunction with the type field where the value of type field is zak. The value of this field denotes the expiry time of the zak token in seconds. For example, if you would like the zak token to be expired after one hour of the token generation, the value of this field should be 3600.

type String No

User token types:
token - Used for starting meetings with the client SDK. This token expires in 14 days and a new token will be returned after the expiry.
zak - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.

Valid values:

  • "zak"
  • "token"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.