Get user presence
Get the presence status for a specific user.
This endpoint is most useful for embedding data about a user's
presence status in other sites (e.g. an employee directory). Full
Zulip clients like mobile/desktop apps will want to use the main
presence endpoint, which returns data for all
active users in the organization, instead.
See Zulip's developer documentation
for details on the data model for presence in Zulip.
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Get presence information for "firstname.lastname@example.org"
result = client.get_user_presence("email@example.com")
curl -sSX GET -G https://firstname.lastname@example.org/presence \
user_id_or_email string required in path
The ID or Zulip display email address of the user whose presence you want to fetch.
Changes: New in Zulip 4.0 (feature level 43). Previous versions only supported
identifying the user by Zulip display email.
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
A typical successful JSON response may look like: