Welcome to the official documentation for FiveRoster, the ultimate web-based platform designed to simplify roster management for your game server communities! Accessible at fiveroster.com, FiveRoster empowers users to create, manage, and share department rosters seamlessly, all while leveraging the power of Discord for secure authentication and roster creation.

Whether you're organizing a gaming clan, managing a roleplay server, or coordinating teams for your community, FiveRoster provides an intuitive and efficient solution to keep your rosters organized and accessible. This documentation is your go-to resource for getting started, mastering features, and troubleshooting any questions you may have.

What is FiveRoster?

FiveRoster is a user-friendly platform that allows you to:

• Create Department Rosters: Build structured rosters for your game server’s departments, such as moderators, admins, or in-game factions, with ease.

• Integrate with Discord: Authenticate securely using your Discord account and pull relevant server membership data to streamline roster creation.

• Manage Teams Efficiently: Organize, update, and share rosters to keep your community aligned and informed.

• Ensure Security:

FiveRoster was created by to address the needs of FiveM server administrators and community leaders looking for a reliable and modern roster management tool away from having to use very manual cumbersome spreadsheets.

Getting Started

Ready to dive in? This documentation will guide you through every step of using FiveRoster. Here’s what you can explore:

Join the FiveRoster Community

FiveRoster is more than just a tool—it’s a community of game server administrators, moderators, and players working together to create unforgettable gaming experiences. Connect with us and other users on our official Discord server to share ideas, get support, or suggest new features.

Have questions or need help? Contact our support team via our official Discord server, accessible through . We’re here to ensure your experience with FiveRoster is nothing short of exceptional.

The first step in getting setup with FiveRoster is to invite our bot to your Discord server. You can do this by being prompted via the dashboard, homepage or alternatively visit .

Once you've clicked the link, you'll be shown a dialog like the one below, simply choose your server from the dropdown list and click the "Continue" button.

Once you've clicked the "Continue" button, you'll then be prompted to choose what permissions to give the FiveRoster bot. For full working functionality make sure that all of the permissions are selected and then click the "Authorize" button to add the bot to your server 🎉

The last thing you want to worry about is ex-players still having access to your department rosters. That's why with FiveRoster, we've made the process easier for both granting players access and also restricting outsiders.

Only members in your Discord server can access your roster

Even though your roster link is publicly accessible, only members of your Discord server itself can access your rosters by default. This prevents ex-players/malicious actors from still having access to your information.

Role based access to view your roster

Along with only server members being able to access your rosters you can go a step further and only allow members with specific Discord roles to view your rosters. This works well if you have multiple departments (LSPD, BCSO, SASP) as well as individual Discord roles for each department.

To do this, click on your server in the dashboard and then click on the "Edit" button to be taken to the roster editor page. From here, scroll down to the bottom right where you see a "Access Controls & Logs" section. From the first dropdown, you can add/remove Discord roles you want players to have before they can view your specific roster.

Once you've selected the roles you'd like, click on the "Save Changes" button at the bottom right of the page to update your roster.

Within FiveRoster there are two distinct types of roster rank callsigns, Static and Dynamic.

Static Callsigns

When a rank is created with a static callsign, this means that at any given time only one singular player can be assigned to this specific rank.

e.g. (Creating a Undersheriff rank for a Sheriff department roster. I only want one player to be Undersheriff so I will set the rank to use a static callsign of 02 with a prefix of S-).

Given this example above, when the roster is viewed publicly, only S-02 will be displayed under the "Undersheriff" rank.

Roster flags can be added to your roster for a range of different purposes. Flags are either yes or no and can be toggled by authorised players within the roster itself.

You could use these flags to mark off leave of absence, whether or not the player is an FTO or if the player assigned to the rank is part of any sub-divisions i.e. (SWAT, K9, HEAT).

We've partnered with Patreon to facilitate premium subscriptions. Upon successfully purchasing premium membership via Patreon, you will be automatically assigned the "Premium" role in the FiveRoster Discord server. This role is crucial for unlocking the benefits of premium on the platform.

You can purchase premium membership here.

Note: You'll need to log out of FiveRoster and log back in after receiving your Premium role for the changes to take effect.

Useful Links & Articles

Enrolling players onto your roster can be done easily via the roster page itself. Only Administrators and Managers can enrol players onto the roster.

API keys are managed on a per Discord server basis. When you add FiveRoster to your Discord server you'll have the option to generate API keys for your specific use within that server.

The data requested through the API will only be for the corresponding server and the rosters created within. If you attempt to retrieve roster information with an API key that isn't tied to the rosters Discord server then you will receive an error.

Generating a new API key

To create a new API key, you'll need to head to the server page in FiveRoster and click on the "Settings" tab. From here, you'll see a section titled "API Key Management". Then, click on the "Create API Key" button in the top right to be shown a modal to provide a name for your key and also set an optional expiry.

Your roster has specific access levels that determine what a player accessing the roster can do depending on their assigned roster rank. You can add/remove roles from ranks at any time and you can learn how to make those changes by clicking here.

🔴 Administrator

Administrators have access to amend the roster completely. They can clear ranks, assign players to specific ranks, promote/demote players and manage player strikes. Ranks with the access of Administrator are unrestricted.

🟡 Manager

Managers cannot change the roster itself but can clear ranks, assign players to specific ranks, promote/demote players and manage player strikes.

⚪ Read-Only

Players with read-only access can only view the roster. They cannot manage ranks or players on the roster.

We plan to release a wide range of different themes and styles to really personalise your department rosters within FiveRoster. There will be plenty of themes to choose from and some themes will be exclusive to premium members.

Before themes are added to FiveRoster, a vote will be held in our official Discord server so you the community can choose if it's worth adding to the platform.

We also have plans to release a Theme Builder which allows you to become a theme creator publishing your creations to the Theme Marketplace for other members to use on their rosters. You can read more about this here.

In order to become a theme creator and publish your themes to the Theme Marketplace you'll need to make sure you have an active Premium subscription.

Opening theme creation to the community is very exciting for us and this is something we are actively working on to get this ready for everyone. Stay tuned for updates via our official Discord server.

Promoting/demoting players in your roster can be done easily via the roster page itself. Only Administrators and Managers can promote/demote players.

Promoting a player ⬆️

Demoting a player ⬇️

So you've created your department roster and you are now ready to build it out with ranks and sections. We designed FiveRoster to be seamless but also intelligent when it comes to ranks. Before adding ranks to your roster, please ensure you've read about .

Adding a new rank to the roster

Player strikes can be managed easily via the roster page itself. Only Administrators and Managers can add/edit/remove player strikes.

Note: Player strikes automatically clear on promotion/demotion.

Adding a new player strike

Player notes can be managed easily via the roster page itself. Only Administrators and Managers can add player notes to the roster.

To access the FiveRoster dashboard, you can visit . If you are not already logged in, you'll be asked to login via Discord. Once you've logged in you'll be automatically redirected to the dashboard page.

You'll see all the Discord servers you are currently a member of and whether or not you have permission to install the FiveRoster bot.

If you've already invited the bot to your Discord server, you'll have the option to "Manage" your rosters.

Authentication

In order to authenticate with the FiveRoster API, you'll need to provide the API key you have generated in the header of the request under "X-API-KEY". The API may return a variety of different error messages:

Rate Limiting

The API has several protections in place to prevent API spam and misuse. By default, the API will rate limit IP addresses that attempt to make more than 50 requests per minute.

Retrieve all roster information

GET /api/v1/rosters

This endpoint is used to retrieve all roster information for a given Discord server and is returned in a JSON format. Rank information and flags are not omitted at this point for all rosters.

Headers

Example Response (200 OK)

Retrieve specific roster information

GET /api/v1/rosters/{roster_uuid}

This endpoint is used to retrieve specific roster information for a given Discord server and is returned in a JSON format. Rank information and flags IS omitted at this point for the roster.

Headers

Example Response (200 OK)

Retrieve roster player information

GET /api/v1/rosters/{roster_uuid}/players

This endpoint is used to retrieve all roster player information for a given roster and is returned in a JSON format. This only includes players enrolled actively on the roster itself.

Headers

Example Response (200 OK)

Code Examples

Here are some examples of how to request information from the FiveRoster API.