Connect Guildbase to whatever else your community runs
Most communities run more than one system: a game server, a Discord bot, a roster, an allowlist. Recruitment touches all of them, and the gap between "application accepted" and "actually has access" is where the manual work lives.
$ curl -H "Authorization: Bearer gb_live_…" \
https://guildbase.gg/api/v1/applications
{
"id": "a3f2…",
"template": "Whitelist Application",
"status": "accepted",
"discord_id": "2419…"
}Your server
What you get with API & Webhooks
Guildbase exposes a REST API, fires webhooks on the events you care about, and provides a session endpoint that external clients — a FiveM script, for example — can use to let players apply without leaving the game.
REST API
Read applications, templates, members, roles and exam results programmatically, authenticated with a per-community API key.
Webhooks on stage changes
Fire a webhook as a workflow action, so your own systems learn about an acceptance at the moment it happens.
In-game apply
An API session endpoint lets an external client authenticate a player and open your application form in-game, rather than telling them to visit a website later.
Certificate and exam endpoints
Check exam attempts and certificates from your own tooling, including whether a certificate is still valid.
FiveRoster and Cosmo
First-party integrations for FiveM communities: add accepted players to a roster, apply flags, or push them onto an allowlist as a workflow action.
Scoped API keys
Keys are issued per community so access can be revoked without touching anything else.
How it works
-
01
Generate an API key for your community
-
02
Add a webhook action to the stages that matter
-
03
Point your bot or server script at the API
-
04
Let acceptance trigger access automatically
API & Webhooks FAQs
Can players apply from inside my game server?
Yes. The API session endpoint is designed for external clients such as FiveM scripts: your script authenticates the player and opens the embedded form, so the application is completed in-session.
What can the REST API do?
Read applications and their status, application templates, members and roles, and exam attempts and certificates. It is how communities connect Guildbase to their own bots and dashboards.
When do webhooks fire?
A webhook is a workflow stage action, so it fires whenever an application reaches that stage. That makes acceptance the trigger for whatever your own systems need to do next.
Is the API available on the free plan?
API access and webhooks are paid plan features. The Discord automation that most communities need is available without them.
Where is the API documented?
At /docs/api, which covers authentication, the available endpoints and their responses.
API & Webhooks in practice
How communities in these games use it, with the application types they typically run.
FiveM applications
Whitelist, department and staff applications for FiveM roleplay servers, with Discord roles and in-game apply built in.
RedM applications
Character and whitelist applications for RedM western roleplay servers, with period-accurate review workflows.
GTA RP applications
Whitelist and character applications for GTA roleplay cities on any framework, from FiveM to RageMP and alt:V.
Works with
Try API & Webhooks on your community
Free to start, no card required. Bring your Discord server and set it up this afternoon.