Developer Documentation

You may or may not need an API key depending on how you intend on operating, head to the Developer Dashboard to get one.

We offer two API endpoints to retrieve information, as listed below:

Get user by Discord ID

GET GET /api/discord/:discord_id
This endpoint supports the server_id query parameter to retrieve the user's verification information for the specified server (pass the 17-19 server id)

Returns a User object

Get Discord IDs by Roblox ID

GET /api/roblox/:roblox_id

Returns a Snowflake List, or an empty array if the Roblox account is not connected.

Reference

User Object

Snowflake List

A list of Discord IDs; example:

Status Codes

The list of possible status codes is as follows:

• 200: All is well
• 401: You tried accessing information that requires an API key, and provided an invalid API key
• 403: You tried to access something you do not have permission to access (i.e a user has set their privacy level to API key required and you did not provide an API key)
• 404: User is not verified
• 500: Something is broken on our end

Authorization

To send authenticated requests, you must pass the API key in the authorization header with the Bearer token type.

Rate Limiting

There is no hard rate limiting as it would be more expensive in terms of performance and cost than not given our infrastructure. However, we expect you to send a reasonable number of requests. Do not spam requests for the fun of it. Abuse may get you blocked or permanently banned from the API.