API Reference

Integrate FiveList into your applications with our RESTful API. Build custom workflows, automate processes, and create powerful integrations.

v1.2
Current Version
99.9%
Uptime
~150ms
Avg Response
1000/hr
Rate Limit

Quick Start

Get up and running with the FiveList API in minutes

1. Get API Key

Generate your API key from the dashboard settings. Keep it secure and never expose it client-side.

Generate API Key →

2. Make Request

Include your API key in the Authorization header. All endpoints use standard HTTP methods.

curl -H "Authorization: Bearer YOUR_KEY"

3. Handle Response

All responses are JSON formatted with consistent error handling and status codes.

{ "data": [...], "status": "success" }

API Endpoints

Applications API

GET

Get Applications

Retrieve a list of applications for your server

Request
curl -X GET "https://api.fivelist.gg/v1/applications" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
Response
{
  "data": [
    {
      "id": "app_1234567890",
      "status": "pending",
      "applicant": {
        "discord_id": "123456789012345678",
        "username": "john_doe#1234"
      },
      "application_type": "whitelist",
      "submitted_at": "2025-02-06T14:30:00Z",
      "answers": [
        {
          "question_id": "q_basic_info",
          "question": "What is your character name?",
          "answer": "John Smith"
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "total_pages": 5,
    "total_count": 47
  }
}
PUT

Update Application Status

Update the status of a specific application

Request
curl -X PUT "https://api.fivelist.gg/v1/applications/app_1234567890/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "approved",
    "notes": "Good application, approved for whitelist",
    "reviewer_id": "user_0987654321"
  }'
Response
{
  "data": {
    "id": "app_1234567890",
    "status": "approved",
    "reviewed_at": "2025-02-06T15:45:00Z",
    "reviewer_id": "user_0987654321",
    "notes": "Good application, approved for whitelist"
  },
  "message": "Application status updated successfully"
}

Authentication

API Key Authentication

Include your API key in the Authorization header using Bearer token format.

Authorization: Bearer fl_key_1234567890abcdef

Base URL

https://api.fivelist.gg/v1
Security Notice

Never expose your API key in client-side code. Always use server-to-server requests.

Rate Limits

1,000
Requests/Hour
100
Requests/Min

Rate Limit Headers

X-RateLimit-LimitRequest limit per window
X-RateLimit-RemainingRequests remaining
X-RateLimit-ResetWindow reset time
Enterprise Limits

Need higher limits? Contact us about enterprise plans with custom rate limits.

Need Help Getting Started?

Our team is here to help you integrate FiveList into your applications. From authentication setup to advanced automation, we've got you covered.

Looking for SDKs? We're working on official libraries for popular languages. Let us know what you need