Get presence of all users
GET https://css2024.zulip.aalto.fi/api/v1/realm/presence
Get the presence information of all the users in an organization.
If the CAN_ACCESS_ALL_USERS_GROUP_LIMITS_PRESENCE
server-level
setting is set to true
, presence information of only accessible
users are returned.
See Zulip's developer documentation
for details on the data model for presence in Zulip.
Usage examples
#!/usr/bin/env python3
import zulip
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Get presence information of all the users in an organization.
result = client.get_realm_presence()
print(result)
curl -sSX GET -G https://css2024.zulip.aalto.fi/api/v1/realm/presence \
-u BOT_EMAIL_ADDRESS:BOT_API_KEY
Parameters
This endpoint does not accept any parameters.
Response
Return values
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:
{
"msg": "",
"presences": {
"iago@zulip.com": {
"aggregated": {
"client": "website",
"status": "active",
"timestamp": 1656958485
},
"website": {
"client": "website",
"pushable": false,
"status": "active",
"timestamp": 1656958485
}
}
},
"result": "success",
"server_timestamp": 1656958539.6287155
}