{% extends "zerver/portico.html" %} {# API information page #} {% load minified_js %} {% block customhead %} {{ block.super }} {% minified_js 'api' %} {% endblock %} {% block portico_content %}

API endpoints documentation

In addition to our pre-built API bindings for Python, we also have a REST-ful web API.

{% autoescape off %} {% for blurb in content %}

{{ blurb.call }}

{{blurb.method}} {{ blurb.endpoint }}

Arguments

{% for argument in blurb.arguments %}
{{ argument.0 }}
{{ argument.1 }}
{% endfor %}

Return values

{% for return in blurb.returns %}
{{ return.0 }}
{{ return.1 }}
{% endfor %}
{% if blurb.example_request %}

Example request

{% for lang, req in blurb.example_request.items %}
{{ req }}
{% endfor %}{% endif %} {% if blurb.rendered_response %}

Example response

{{ blurb.rendered_response }}
{% endif %}
{% endfor %} {% endautoescape %} {% endblock %}