API reference

REST API used by the dashboard, the bot, and your own integrations. All requests are authenticated via Discord-issued sessions or signed bot tokens.

  • GET/api/auth/meCurrent user
  • POST/api/auth/logoutSign out
  • GET/api/guildsList my guilds
  • GET/api/guilds/:guildIdGuild details
  • GET/api/guilds/:guildId/overviewOverview metrics
  • GET/api/guilds/:guildId/settingsRead settings
  • PUT/api/guilds/:guildId/settingsUpdate settings
  • POST/api/verification/sessionCreate a verification session
  • GET/api/verification/session/:tokenRead a session
  • POST/api/verification/completeFinish verification
  • POST/api/verification/retryRetry verification
  • DELETE/api/verification/unlinkUnlink the current user
  • GET/api/guilds/:guildId/membersList linked members
  • GET/api/guilds/:guildId/members/:memberIdMember detail
  • POST/api/guilds/:guildId/members/:memberId/resyncForce resync
  • DELETE/api/guilds/:guildId/members/:memberId/linkUnlink a member
  • GET/api/guilds/:guildId/groupsList groups
  • POST/api/guilds/:guildId/groupsAdd a Roblox group
  • DELETE/api/guilds/:guildId/groups/:groupIdRemove a group
  • GET/api/guilds/:guildId/mappingsList mappings
  • POST/api/guilds/:guildId/mappingsCreate mapping
  • PUT/api/guilds/:guildId/mappings/:mappingIdUpdate mapping
  • DELETE/api/guilds/:guildId/mappings/:mappingIdRemove mapping
  • GET/api/guilds/:guildId/logsList audit logs
  • GET/api/guilds/:guildId/logs/exportExport logs as CSV
  • POST/api/guilds/:guildId/resyncQueue guild-wide resync
  • POST/api/guilds/:guildId/sync/previewDry-run sync
  • GET/api/guilds/:guildId/teamList teammates
  • POST/api/guilds/:guildId/team/inviteInvite teammate
  • PATCH/api/guilds/:guildId/team/:memberIdUpdate teammate role
  • DELETE/api/guilds/:guildId/team/:memberIdRemove teammate
  • GET/api/guilds/:guildId/billingBilling info
  • POST/api/guilds/:guildId/billing/checkoutStart checkout
  • POST/api/billing/webhookStripe webhook
  • GET/api/admin/metricsPlatform metrics
  • GET/api/admin/guildsAll guilds
  • POST/api/admin/guilds/:guildId/suspendSuspend a guild
  • POST/api/admin/guilds/:guildId/unsuspendRestore a guild