Get all invitations
GET https://wellesleycs240f21.zulipchat.com/api/v1/invites
Fetch all unexpired invitations (i.e. email
invitations and reusable invitation links) that can be managed by the user.
Note that administrators can manage invitations that were created by other users.
Changes: Prior to Zulip 8.0 (feature level 209), non-admin users could
only create email invitations, and therefore the response would never include
reusable invitation links for these users.
Usage examples
#!/usr/bin/env python3
import zulip
# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")
# Get all invitations.
result = client.call_endpoint(url="/invites", method="GET")
print(result)
curl -sSX GET -G https://wellesleycs240f21.zulipchat.com/api/v1/invites \
-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:
{
"invites": [
{
"email": "example@zulip.com",
"expiry_date": null,
"id": 1,
"invited": 1710606654,
"invited_as": 200,
"invited_by_user_id": 9,
"is_multiuse": false,
"notify_referrer_on_join": true
},
{
"expiry_date": 1711463862,
"id": 1,
"invited": 1710599862,
"invited_as": 400,
"invited_by_user_id": 9,
"is_multiuse": true,
"link_url": "https://example.zulipchat.com/join/yddhtzk4jgl7rsmazc5fyyyy/",
"notify_referrer_on_join": true
}
],
"msg": "",
"result": "success"
}