POST /jwt/fetch_api_key

This API endpoint is used by clients to implement JSON Web Token (JWT) authentication. Given a JWT identifying a Zulip user, it returns a Zulip API key that the client can use to make requests as the user.

!!! warn ""

**Note:** This endpoint is only useful for Zulip servers/organizations
with [JSON web token authentication][prod-jwt-auth] enabled.

See the API keys documentation for more details on how to manage API keys manually.

Changes: New in Zulip 7.0 (feature level 160).

Servers

https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description

Name	Type	Required	Description
`token`	String	Yes	A JSON Web Token for the target user. The token payload must contain a custom `email` claim with the target user's email address, e.g., `{"email": "<target user email>"}`.
`include_profile`	Boolean	No	Whether to include a `user` object containing the target user's profile details in the response. Default value: false

token

String

Yes

A JSON Web Token for the target user.

The token payload must contain a custom email claim with the target user's email address, e.g., {"email": "<target user email>"}.

include_profile

Boolean

Whether to include a user object containing the target user's profile details in the response.

Default value: false

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.