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
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 -X GET https://yourZulipDomain.zulipchat.com/api/v1/users/<email>/presence \
The email address of the user whose presence you want to fetch.
presence: An object containing the presence details for every type
of client the user has ever logged into.
aggregated: the keys for these objects are
the names of the different clients where this user is logged in,
ZulipMobile. There is also an
aggregated key, which matches
the contents of the object that has been updated most
recently. For most applications, you'll just want to look at the
timestamp: when this update was received; if the timestamp
is more than a few minutes in the past, the user is offline.
idle: whether the user had
recently interacted with Zulip at the time in the timestamp
(this distinguishes orange vs. green dots in the Zulip web
UI; orange/idle means we don't know whether the user is
actually at their computer or just left the Zulip app open
on their desktop).
pushable: whether the client accepts push notifications or not.
client: the name of the client this presence information refers to.
Matches the object's key if this isn't the
A typical successful JSON response may look like: