How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zulip

Zulip invites API

The invites API from Zulip — 5 operation(s) for invites.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zulip invites API is one of 17 APIs that Zulip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Invites. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 5 base URLs: https://{subdomain}.zulipchat.com/api/v1, {server}/api/v1, https://chat.zulip.org/api/v1, http://localhost:9991/api/v1, http://{subdomain}.testserver/json.

6 operations 5 paths 10 schemas 2 DELETE1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Servers
https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1
http://localhost:9991/api/v1
http://{subdomain}.testserver/json
Authentication
HTTP Basic
Contact
https://zulip.com
License
Apache 2.0
Resource Areas
1

Authentication & Security 1

Zulip invites API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — Basic authentication, with the user's email as the username, and the API key as the password. The API key can be fetched using the /fetchapikey or /devfetchapi…

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 2 DELETE, 1 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

invites 6
GET
/invites
Get all invitations
get-invites → 200
POST
/invites
Send invitations
send-invites body → 200400
POST
/invites/multiuse
Create a reusable invitation link
create-invite-link body → 200400
DELETE
/invites/{invite_id}
Revoke an email invitation
revoke-email-invite 1 param → 200400
DELETE
/invites/multiuse/{invite_id}
Revoke a reusable invitation link
revoke-invite-link 1 param → 200400
POST
/invites/{invite_id}/resend
Resend an email invitation
resend-email-invite 1 param → 200400

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Invite (9 properties), JsonResponseBase (1 property). Each schema is shown below with its type and property counts.

InvitationFailedError
Invite
object
A dictionary containing details about an [invitation](/help/invite-new-users).
9 properties
JsonResponseBase
object
1 property
JsonSuccess
InviteRoleParameter
integer
The [organization-level role](/api/roles-and-permissions) of the user that is created when the invitation is accepted. Possible values are: - 100 = Organizatio…
IgnoredParametersUnsupported
array
An array of any parameters sent in the request that are not supported by the endpoint. See [error handling](/api/rest-error-handlingignored-parameters) documen…
JsonSuccessBase
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…
CodedError
CodedErrorBase
InviteExpirationParameter
integernull
The number of minutes before the invitation will expire. If null, the invitation will never expire. If unspecified, the server will use a default value (based…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zulip-invites-api-openapi.yml Raw ↑

Other APIs Zulip publishes across the network.

Zulip REST API
AE Profile APIs.io
Zulip Events API
AE Profile APIs.io
Zulip Webhooks
AE Profile APIs.io
Zulip authentication API
AE Profile APIs.io
Zulip bots API
AE Profile APIs.io
Zulip channels API
AE Profile APIs.io
Zulip drafts API
AE Profile APIs.io
Zulip messages API
AE Profile APIs.io
Zulip mobile API
AE Profile APIs.io
Zulip navigation_views API
AE Profile APIs.io
Zulip real_time_events API
AE Profile APIs.io
Zulip reminders API
AE Profile APIs.io
#Invites
← Back to Z APIs
API Details
ID
zulip:zulip-invites-api
Server
https://{subdomain}.zulipchat.com/api/v1
Docs
https://zulip.com/api/rest
Provider
Zulip
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zulip-invites-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zulip-invites-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Zulip invites API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.