List users (development only)

GET https://chat.zulip.org/api/v1/dev_list_users

Get a list of all, non-bot users in a Zulip development server. This endpoint is used by mobile developers to fetch users for the development login flow.

Note: This endpoint is only available on Zulip development servers; for obvious security reasons it will always return an error in a Zulip production server.

Usage examples

curl -sSX GET -G https://chat.zulip.org/api/v1/dev_list_users

Parameters

This endpoint does not accept any parameters.

Response

Return values

  • direct_admins: (object)[]

    A list of administrators in the development server.

    • email: string

      The email of the dev admin user.

    • realm_url: string

      The URL of the dev admin user's organization.

  • direct_users: (object)[]

    A list of non-admin users in the development server.

    • email: string

      The email of the dev user.

    • realm_url: string

      The URL of the dev user's organization.

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:

{
    "direct_admins": [
        {
            "email": "iago@zulip.com",
            "realm_url": "http://localhost:9991"
        }
    ],
    "direct_users": [
        {
            "email": "hamlet@zulip.com",
            "realm_url": "http://localhost:9991"
        }
    ],
    "msg": "",
    "result": "success"
}