zulip/templates/zerver/help/include/rest-endpoints.md

#### Messages

* [Get messages](/api/get-messages)
* [Get a raw message](/api/get-raw-message)
* [Send a message](/api/send-message)
* [Update a message](/api/update-message)
* [Add an emoji reaction](/api/add-emoji-reaction)
* [Remove an emoji reaction](/api/remove-emoji-reaction)
* [Render a message](/api/render-message)
* [Upload a file](/api/upload-file)
* [Delete a message](/api/delete-message)
* [Construct a narrow](/api/construct-narrow)
* [Get a message's edit history](/api/get-message-history)
* [Update a message's flags](/api/update-message-flags)
* [Mark messages as read in bulk](/api/mark-as-read-bulk)

#### Streams

* [Get all streams](/api/get-all-streams)
* [Get subscribed streams](/api/get-subscribed-streams)
* [Add subscriptions](/api/add-subscriptions)
* [Update subscription settings](/api/update-subscription-properties)
* [Remove subscriptions](/api/remove-subscriptions)
* [Get subscription status](/api/get-subscription-status)
* [Get topics in a stream](/api/get-stream-topics)
* [Topic muting](/api/mute-topics)
* [Create a stream](/api/create-stream)
* [Get stream ID](/api/get-stream-id)
* [Delete a stream](/api/delete-stream)
* [Update a stream](/api/update-stream)

#### Users

* [Get all users](/api/get-all-users)
* [Get a user](/api/get-user)
* [Deactivate a user](/api/deactivate-user)
* [Reactivate a user](/api/reactivate-user)
* [Update a user](/api/update-user)
* [Get profile](/api/get-profile)
* [Create a user](/api/create-user)
* [Set "typing" status](/api/typing)
* [Get user presence](/api/get-presence)
* [Get all user groups](/api/get-user-groups)
* [Update notification settings](/api/update-notification-settings)
* [Create a user group](/api/create-user-group)
* [Update a user group](/api/update-user-group)
* [Delete a user group](/api/delete-user-group)
* [Get attachments](/api/get-attachments)

#### Server & organizations

* [Get server settings](/api/server-settings)
* [List linkifiers](/api/list-linkifiers)
* [Create linkifiers](/api/add-linkifiers)
* [Remove linkifiers](/api/remove-linkifiers)
* [Get all custom emoji](/api/get-org-emoji)
* [Upload custom emoji](/api/upload-custom-emoji)

#### Real-time events

* [Real time events API](/api/real-time-events)
* [Register an event queue](/api/register-queue)
* [Get events from an event queue](/api/get-events-from-queue)
* [Delete an event queue](/api/delete-queue)

#### Specialty endpoints
* [Fetch a development API key](/api/dev-fetch-api-key)
/api: Move list of REST endpoints to a template. 2018-04-17 00:49:37 +02:00			`#### Messages`

api docs: Document the GET /messages endpoint. 2018-06-23 17:31:12 +02:00			`* [Get messages](/api/get-messages)`
api docs: Document the GET /messages/<message_id> endpoint. 2018-06-23 18:17:05 +02:00			`* [Get a raw message](/api/get-raw-message)`
api docs: Merge docs for sending stream and private messages. 2018-06-18 17:44:48 +02:00			`* [Send a message](/api/send-message)`
/api: Move list of REST endpoints to a template. 2018-04-17 00:49:37 +02:00			`* [Update a message](/api/update-message)`
api: Document POST ../messages/{message_id}/reactions endpoint. This refactors add_reaction in python_examples.py to use the openapi_test_function decorator and validate result with validate_against_openapi_schema. Minor changes have been made to the OpenAPI format data for /messages/{message_id}/reactions endpoint. This also adds add-emoji.md to templates/zerver/api and adds add-emoji to rest-endpoints.md (templates/zerver/help/include). 2020-02-29 15:02:34 +01:00			`* [Add an emoji reaction](/api/add-emoji-reaction)`
api: Document DELETE ../messages/{message_id}/reactions endpoint. This refactors remove_reaction in python_examples.py to validate the result with validate_against_openapi_schema. Minor changes and some additions have been made to the OpenAPI format data for /messages/{message_id}/reactions endpoint. 2020-03-07 11:20:57 +01:00			`* [Remove an emoji reaction](/api/remove-emoji-reaction)`
API: Reorganize message section of endpoints index a bit. 2018-08-08 18:42:26 +02:00			`* [Render a message](/api/render-message)`
			`* [Upload a file](/api/upload-file)`
api docs: Document the DELETE /messages/<message_id> endpoint. 2018-06-26 16:30:46 +02:00			`* [Delete a message](/api/delete-message)`
api docs: Add guide for creating narrows. Dramatically edited by tabbott to simplify the discussion and duplication of content in our main search documentation. 2018-06-23 16:28:00 +02:00			`* [Construct a narrow](/api/construct-narrow)`
api docs: Document the GET /messages/<message_id>/history endpoint. 2018-06-27 22:54:08 +02:00			`* [Get a message's edit history](/api/get-message-history)`
api docs: Document the POST /messages/flags endpoint. 2018-07-03 18:17:23 +02:00			`* [Update a message's flags](/api/update-message-flags)`
api docs: Document POST /mark_(all\|stream\|topic)_as_read. 2018-08-11 13:38:55 +02:00			`* [Mark messages as read in bulk](/api/mark-as-read-bulk)`
/api: Move list of REST endpoints to a template. 2018-04-17 00:49:37 +02:00
			`#### Streams`

			`* [Get all streams](/api/get-all-streams)`
			`* [Get subscribed streams](/api/get-subscribed-streams)`
			`* [Add subscriptions](/api/add-subscriptions)`
api docs: Document the POST /users/me/subscriptions/properties endpoint. 2018-07-12 10:09:50 +02:00			`* [Update subscription settings](/api/update-subscription-properties)`
/api: Move list of REST endpoints to a template. 2018-04-17 00:49:37 +02:00			`* [Remove subscriptions](/api/remove-subscriptions)`
api: Add GET /users/{user_id}/subscription/{stream_id} endpoint. This new endpoint returns a 'user' dictionary which, as of now, contains a single key 'is_subscribed' with a boolean value that represents whether the user with the given 'user_id' is subscribed to the stream with the given 'stream_id'. Fixes #14966. 2020-05-31 19:10:41 +02:00			`* [Get subscription status](/api/get-subscription-status)`
api docs: Document the /users/me/<stream_id>/topics endpoint. 2018-06-01 18:58:07 +02:00			`* [Get topics in a stream](/api/get-stream-topics)`
api docs: Document the PATCH /users/me/subscriptions/muted_topics endpoint. 2018-07-10 08:17:35 +02:00			`* [Topic muting](/api/mute-topics)`
api docs: Explain clearly how to create new streams. Tweaked significantly by tabbott to cover this more clearly. 2018-06-26 21:33:13 +02:00			`* [Create a stream](/api/create-stream)`
api docs: Move "Get stream ID" to end of the streams endpoint section. This seemed overally emphasized in the previous order. 2018-07-27 00:42:58 +02:00			`* [Get stream ID](/api/get-stream-id)`
api_docs: Add documentation for delete_stream. 2019-06-22 08:22:32 +02:00			`* [Delete a stream](/api/delete-stream)`
api_docs: Add documentation for update_stream. 2019-06-23 14:38:28 +02:00			`* [Update a stream](/api/update-stream)`
/api: Move list of REST endpoints to a template. 2018-04-17 00:49:37 +02:00
			`#### Users`

			`* [Get all users](/api/get-all-users)`
api: Document GET ../users/{user_id} endpoint. This adds get_single_user to python_examples.py in zerver/openapi. This also adds get-single-user.md to templates/zerver/api and adds get-single-user to rest-endpoints.md (templates/zerver/help/include). 2020-02-14 21:39:12 +01:00			`* [Get a user](/api/get-user)`
api: Document DELETE ../users/{user_id} endpoint. This adds deactivate_user to python_examples.py in zerver/openapi. This also adds delete-user.md to templates/zerver/api and adds delete-user to rest-endpoints.md (templates/zerver/help/include). 2020-02-14 22:02:24 +01:00			`* [Deactivate a user](/api/deactivate-user)`
api docs: Document POST /users/{user_id}/reactivate endpoint. 2020-05-19 19:12:02 +02:00			`* [Reactivate a user](/api/reactivate-user)`
api: Document PATCH ../users/{user_id} endpoint. This adds update_user to python_examples.py in zerver/openapi. This also adds update-user.md to templates/zerver/api and adds update-user to rest-endpoints.md (templates/zerver/help/include). 2020-02-14 22:13:01 +01:00			`* [Update a user](/api/update-user)`
/api: Move list of REST endpoints to a template. 2018-04-17 00:49:37 +02:00			`* [Get profile](/api/get-profile)`
			`* [Create a user](/api/create-user)`
api docs: Document POST /typing. 2018-08-09 20:27:12 +02:00			`* [Set "typing" status](/api/typing)`
api docs: Document GET /users/<email>/presence. Tweaked by tabbott to describe more clearly what this is for. 2018-08-07 17:52:03 +02:00			`* [Get user presence](/api/get-presence)`
api: Add GET /user_groups documentation. This documents our GET endpoint for interacting with Zulip's user groups feature. Fixes #10298. 2018-08-18 23:06:53 +02:00			`* [Get all user groups](/api/get-user-groups)`
api docs: Document PATCH /settings/notifications. With significant tweaks by tabbott after rebasing. 2018-08-10 02:15:45 +02:00			`* [Update notification settings](/api/update-notification-settings)`
api_docs: Add documentation for create_user_group. 2019-06-24 22:27:06 +02:00			`* [Create a user group](/api/create-user-group)`
api_docs: Add documentation for update_user_group. 2019-06-25 21:43:53 +02:00			`* [Update a user group](/api/update-user-group)`
api_docs: Add documentation for remove_user_group. 2019-06-25 22:00:34 +02:00			`* [Delete a user group](/api/delete-user-group)`
openapi: Document GET /attachments endpoint. 2020-03-20 23:23:25 +01:00			`* [Get attachments](/api/get-attachments)`
/api: Move list of REST endpoints to a template. 2018-04-17 00:49:37 +02:00
api docs: Document POST /realm/filters. 2018-08-14 02:54:36 +02:00			`#### Server & organizations`

api docs: Document GET /server_settings. 2018-08-11 15:50:56 +02:00			`* [Get server settings](/api/server-settings)`
linkifiers: Rename articles to current feature name. These were previously called "linkification filters", but we now want to consistently refer to them as "linkifiers" in the UI and API docs. 2018-10-16 21:01:17 +02:00			`* [List linkifiers](/api/list-linkifiers)`
api docs: Fix titles for add/remove linkifiers docs. 2018-10-18 00:35:53 +02:00			`* [Create linkifiers](/api/add-linkifiers)`
			`* [Remove linkifiers](/api/remove-linkifiers)`
api: Document the GET /realm/emoji endpoint. 2018-07-03 20:22:53 +02:00			`* [Get all custom emoji](/api/get-org-emoji)`
api docs: Document the custom emoji upload endpoint. Tweaked by tabbott to fix some English phrasing and make the file pointer thing require less Python knowledge. Fixes: #10746. 2018-12-12 19:49:14 +01:00			`* [Upload custom emoji](/api/upload-custom-emoji)`
api docs: Document GET /server_settings. 2018-08-11 15:50:56 +02:00
api: Improve documentation for real-time-events API. 2018-04-28 00:29:47 +02:00			`#### Real-time events`
api docs: Document the /dev_fetch_api_key endpoint. 2018-06-21 15:23:10 +02:00
api: Improve documentation for real-time-events API. 2018-04-28 00:29:47 +02:00			`* [Real time events API](/api/real-time-events)`
api: Document the /register API with a lot more detail. 2018-04-28 02:01:41 +02:00			`* [Register an event queue](/api/register-queue)`
			`* [Get events from an event queue](/api/get-events-from-queue)`
			`* [Delete an event queue](/api/delete-queue)`
api docs: Document the /dev_fetch_api_key endpoint. 2018-06-21 15:23:10 +02:00
			`#### Specialty endpoints`
			`* [Fetch a development API key](/api/dev-fetch-api-key)`