The following document outlines every Read API route available via NodeBB. Unlike the write API, the v1.x API was coded organically, and is **not** strictly RESTful. These shortcomings will be addressed in the v2.x version of the API.
## Authentication
Authentication with this API is done via cookies. A valid login session is required for API calls that pertain to operations involving a logged-in user. For example, `/api/unread` is a route showing unread topics, and is not accessible by guest users.
tags:
- name:home
description:Routes used at the forum index only
@ -38,6 +42,8 @@ paths:
get:
tags:
- home
description:|
This route is used to populate the homepage of NodeBB. It is the main access point of the forum, and shows a list of categories for navigation purposes.