Fetch an API key (development only)

POST https://gizmo.zulipchat.com/api/v1/dev_fetch_api_key

For easy testing of mobile apps and other clients and against Zulip development servers, we support fetching a Zulip API key for any user on the development server without authentication (so that they can implement analogues of the one-click login process available for Zulip development servers on the web).

Usage examples

curl -sSX POST https://gizmo.zulipchat.com/api/v1/dev_fetch_api_key \
    --data-urlencode username=iago@zulip.com

Parameters

Response

Return values

• api_key: string

  The API key that can be used to authenticate as the requested user.

• email: string

  The email address of the user who owns the API key.

• user_id: integer

  The unique ID of the user who owns the API key.

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

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "api_key": "gjA04ZYcqXKalvYMA8OeXSfzUOLrtbZv",
    "email": "iago@zulip.com",
    "msg": "",
    "result": "success",
    "user_id": 5
}