Zulip Users API

The users API from Zulip — 29 operation(s) for users.

Operations 43

GET /attachments Get attachments #
DELETE /attachments/{attachment_id} Delete an attachment #
GET /users Get users #
POST /users Create a user #
POST /users/{user_id}/reactivate Reactivate a user #
POST /users/{user_id}/status Update user status #
GET /users/{user_id}/status Get a user's status #
GET /users/{user_id_or_email}/presence Get a user's presence #
GET /users/me Get own user #
DELETE /users/me Deactivate own user #
POST /users/me/api_key/regenerate Regenerate your API key #
GET /users/me/alert_words Get all alert words #
POST /users/me/alert_words Add alert words #
DELETE /users/me/alert_words Remove alert words #
POST /users/me/presence Update your presence #
PATCH /users/me/profile_data Update your profile data #
DELETE /users/me/profile_data Remove your profile data #
POST /users/me/status Update your status #
POST /users/me/muted_users/{muted_user_id} Mute a user #
DELETE /users/me/muted_users/{muted_user_id} Unmute a user #
POST /users/me/apns_device_token Add an APNs device token #
DELETE /users/me/apns_device_token Remove an APNs device token #
POST /users/me/android_gcm_reg_id Add an FCM registration token #
DELETE /users/me/android_gcm_reg_id Remove an FCM registration token #
GET /users/{email} Get a user by email #
PATCH /users/{email} Update a user by email #
GET /users/{user_id} Get a user #
PATCH /users/{user_id} Update a user #
DELETE /users/{user_id} Deactivate a user #
PATCH /settings Update settings #
POST /typing Set "typing" status #
POST /messages/{message_id}/typing Set "typing" status for message editing #
POST /user_groups/create Create a user group #
POST /user_groups/{user_group_id}/members Update user group members #
GET /user_groups/{user_group_id}/members Get user group members #
PATCH /user_groups/{user_group_id} Update a user group #
GET /user_groups Get user groups #
POST /user_groups/{user_group_id}/subgroups Update subgroups of a user group #
GET /user_groups/{user_group_id}/subgroups Get subgroups of a user group #
GET /user_groups/{user_group_id}/members/{user_id} Get user group membership status #
POST /user_groups/{user_group_id}/deactivate Deactivate a user group #
GET /bots/{bot_id}/api_key Get a bot's API key #
POST /bots/{bot_id}/api_key/regenerate Regenerate a bot's API key #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/zulip-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zulip-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 1.0.0
  title: Zulip REST Users API
  description: Powerful open source group chat
  contact:
    url: https://zulip.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{subdomain}.zulipchat.com/api/v1
  variables:
    subdomain:
      default: example
- url: '{server}/api/v1'
  variables:
    server:
      default: https://
- url: https://chat.zulip.org/api/v1
- url: http://localhost:9991/api/v1
- url: http://{subdomain}.testserver/json
security:
- basicAuth: []
tags:


# --- truncated at 32 KB (222 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zulip/refs/heads/main/openapi/zulip-users-api-openapi.yml