> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blox.report/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

Welcome to the Blox.report API 👋

This API gives you direct access to the backend of Blox.report, allowing you to integrate it into your moderation workflows, staff dashboards and Roblox games.

### What you can do with the API

Currently, the Blox.report API supports:

* Checking report eligibility
* Reporting users
* Managing reports (claim/unclaim/dismiss/approve/undo)

We plan to try and implement more endpoints soon!

### How it's structured

Each endpoint has its own response structure. In the case of an error, it will always try and return in the format `{ success: false, message }` . When the route has a set schema, the response will also the `errors` field in the format of `{ field, message }`.

### Getting started

To start using the API, head to the Blox.report dashboard to create an API key for your server.

### Limitations

You can only make a requests for the server the API key is assigned to. This is an intended security feature and is unlikely to change in the future unless there is a necessary use case.