# Plazza Developers

> Build with the Plazza API.

- [Overview](https://docs.plazza.ca/overview.md): Build with the Plazza API.
- [Quickstart](https://docs.plazza.ca/quickstart.md): Make your first request to the Plazza API.
- [Authentication](https://docs.plazza.ca/guides/authentication.md): Send the session token of a signed-in Plazza account.
- [Errors](https://docs.plazza.ca/guides/errors.md): One error shape for every endpoint, in French or English.
- [Rate limits](https://docs.plazza.ca/guides/rate-limits.md): How many requests you can send, and what to do at the limit.
- [REST API](https://docs.plazza.ca/api-reference/overview.md): The endpoints of the Plazza API.
- [Get your account](https://docs.plazza.ca/api-reference/accounts/get-your-account.md): The account the session token belongs to.
- [List roadmap items](https://docs.plazza.ca/api-reference/roadmap/list-roadmap-items.md): Published items, most backed first unless `orderBy` says otherwise, in the `BASIC` view unless `view` asks for `FULL`. Pages hold up to 200 basic items or 50 full ones. Keep `view`, `filter` and `orderBy` the same while paging.
- [Suggest a roadmap item](https://docs.plazza.ca/api-reference/roadmap/suggest-a-roadmap-item.md): Published at once, in the backlog, with your vote. Your first post or comment needs a `displayName`.
- [Get roadmap facets](https://docs.plazza.ca/api-reference/roadmap/get-roadmap-facets.md): The tags, plans and areas a board's published items use, to filter on.
- [Get a roadmap item](https://docs.plazza.ca/api-reference/roadmap/get-a-roadmap-item.md): A published item, a merged one, which names its canonical item in `mergedInto`, or a withdrawn one while its discussion lives on.
- [Withdraw a roadmap item](https://docs.plazza.ca/api-reference/roadmap/withdraw-a-roadmap-item.md): Its author takes their suggestion back: the text is erased, and the discussion stays. Returns the item, with its `deleteTime`.
- [Update a roadmap item](https://docs.plazza.ca/api-reference/roadmap/update-a-roadmap-item.md): Its author rewords their suggestion: the title and the description.
- [List roadmap item activities](https://docs.plazza.ca/api-reference/roadmap/list-roadmap-item-activities.md): An item's timeline: the statuses it moved to, newest first.
- [List roadmap comments](https://docs.plazza.ca/api-reference/roadmap/list-roadmap-comments.md): An item's top-level comments, or with a `parent` filter, one comment's replies. Removed comments stay, as tombstones, so their replies keep their place.
- [Comment on a roadmap item](https://docs.plazza.ca/api-reference/roadmap/comment-on-a-roadmap-item.md): A top-level comment, or a reply to one. Your first post or comment needs a `displayName`.
- [Get a roadmap comment](https://docs.plazza.ca/api-reference/roadmap/get-a-roadmap-comment.md)
- [Remove a roadmap comment](https://docs.plazza.ca/api-reference/roadmap/remove-a-roadmap-comment.md): Its author erases its text; its replies stay. Returns the comment, with its `deleteTime`.
- [Update a roadmap comment](https://docs.plazza.ca/api-reference/roadmap/update-a-roadmap-comment.md): Its author edits its text.
- [Vote for a roadmap item](https://docs.plazza.ca/api-reference/roadmap/vote-for-a-roadmap-item.md)
- [Take back a roadmap vote](https://docs.plazza.ca/api-reference/roadmap/take-back-a-roadmap-vote.md)
- [Follow a roadmap item](https://docs.plazza.ca/api-reference/roadmap/follow-a-roadmap-item.md): To hear about its progress, in the language given. Following again changes it.
- [Stop following a roadmap item](https://docs.plazza.ca/api-reference/roadmap/stop-following-a-roadmap-item.md)
- [React to a roadmap comment](https://docs.plazza.ca/api-reference/roadmap/react-to-a-roadmap-comment.md)
- [Take back a roadmap reaction](https://docs.plazza.ca/api-reference/roadmap/take-back-a-roadmap-reaction.md)
- [Get your roadmap item viewer state](https://docs.plazza.ca/api-reference/roadmap/get-your-roadmap-item-viewer-state.md): Whether you back, follow or suggested the item.
- [Batch get your roadmap item viewer states](https://docs.plazza.ca/api-reference/roadmap/batch-get-your-roadmap-item-viewer-states.md): Your viewer states on up to 50 items, in the order named, to show on a page of them. Use `-` as the item to read across the board. One name that is invalid, outside the parent or not found fails the whole request.
- [Get your roadmap comment viewer state](https://docs.plazza.ca/api-reference/roadmap/get-your-roadmap-comment-viewer-state.md): Whether you wrote the comment, and how you reacted to it.
- [Batch get your roadmap comment viewer states](https://docs.plazza.ca/api-reference/roadmap/batch-get-your-roadmap-comment-viewer-states.md): Your viewer states on up to 50 comments, in the order named, to show on a page of them. Use `-` as the comment to read across an item, and as the item too to read across the board. One name that is invalid, outside the parent or not found fails the whole request.
- [Get your roadmap persona](https://docs.plazza.ca/api-reference/roadmap/get-your-roadmap-persona.md): The name shown with what you post. Not found until your first post or comment.
- [Update your roadmap persona](https://docs.plazza.ca/api-reference/roadmap/update-your-roadmap-persona.md): Renames you on everything you posted on the roadmap.
- [Report roadmap content](https://docs.plazza.ca/api-reference/roadmap/report-roadmap-content.md): Flags an item or a comment for staff to review. Reports are private.

## OpenAPI Specs

- [backend](/openapi/backend.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.