API Documentation

Check if a Roblox User is Verified

This endpoint checks whether a Roblox user is verified and registered with a Discord account.

{
    "status": "success",
    "message": "Verified user.",
    "verified": true
}

fetch('https://api.roshield.net/beta/public/is-verified/123456789', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Check if a Roblox User is Flagged

This endpoint checks whether a Roblox user has any flags or notes registered in the system.

{
    "status": "success",
    "message": "User found.",
    "flags": ["High-risk user.", "Exploiting."]
}

{
    "status": "success",
    "message": "No flags registered for this user."
}

fetch('https://api.roshield.net/beta/public/is-flagged/123456789', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Check if a User is a Server Booster

This endpoint checks if a user is a server booster on Discord based on their premium status.

{
    "status": "success", 
    "is_booster": true,
    "premium_since": "2025-01-09T12:34:56"
}

{
    "status": "error",
    "message": "User not found in server"
}

fetch('https://api.roshield.net/beta/public/is-booster/1191892647976120390/1234', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Get Roblox ID for a Discord User

This endpoint retrieves the Roblox user ID associated with a given Discord user ID.

{
    "status": "success",
    "message": "User found.",
    "roblox_id": "123456789"
}

fetch('https://api.roshield.net/beta/public/discord-to-roblox/1312442314001481861', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Get Discord ID for a Roblox User

This endpoint retrieves the Discord user ID(s) associated with a given Roblox user ID.

{
    "status": "success",
    "message": "User found.",
    "discord_ids": ["1312442314001481861", "1189225868271304774"]
}

fetch('https://api.roshield.net/beta/public/roblox-to-discord/123456789', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Webhook API

This endpoint allows you to send messages to a specific webhook for a Roblox group. You must provide an API key and the name of the webhook to send a message. This can be used to notify group owners or perform other webhook-related tasks.

{
    "status": "success",
    "message": "Webhook posted."
}

fetch('https://api.roshield.net/beta/public/webhooks/myWebhook', {
    method: 'POST',
    headers: {
        'Authorization': 'your-api-key',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        message: 'This is a test message to the webhook!'
    })
})
.then(response => response.json())
.then(data => console.log(data));

Join Request Management

Check if a user has a pending join request for your group.

{
    "status": "success",
    "message": "User has pending join request.",
    "has_pending_request": true,
    "data": {
        "user_id": "123456789",
        "created": "2025-01-09T12:34:56Z",
        "join_request_id": "abc123"
    }
}

{
    "status": "error",
    "message": "User has no pending join request."
}

fetch('https://api.roshield.net/v2/roblox/users/123456789/join-request', {
    method: 'GET',
    headers: {
        'Authorization': 'your-api-key'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Accept a pending join request for a user in your group.

{
    "status": "success",
    "message": "Join request accepted successfully.",
    "data": {
        "user_id": "123456789",
        "accepted": "2025-01-09 12:34:56"
    }
}

fetch('https://api.roshield.net/v2/roblox/users/123456789/join-request', {
    method: 'POST',
    headers: {
        'Authorization': 'your-api-key',
        'Content-Type': 'application/json'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Update User Rank

Update a user's rank in your group. Requires the user to be a member of the group.

{
    "status": "success",
    "message": "Rank updated successfully.",
    "data": {
        "new_rank": "Member"
    }
}

{
    "status": "error",
    "message": "User is not a member of this group."
}

fetch('https://api.roshield.net/v2/roblox/users/123456789/update-rank', {
    method: 'POST',
    headers: {
        'Authorization': 'your-api-key',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        rank_id: 10
    })
})
.then(response => response.json())
.then(data => console.log(data));

Get Bot Account

Retrieve bot account tokens for group operations. This is used internally by other endpoints.

{
    "status": "success",
    "message": "Bot account tokens retrieved successfully.",
    "data": {
        "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
        "refresh_token": "refresh_token_here",
        "expires_at": "2025-01-10T12:34:56Z"
    }
}

{
    "status": "error",
    "message": "No bot account connected for this group."
}

fetch('https://api.roshield.net/v2/roblox/groups/123456789/get-bot-account', {
    method: 'POST',
    headers: {
        'Authorization': 'your-api-key',
        'Content-Type': 'application/json'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Get Server Name

Retrieve the server name for a specific Roblox place and job ID combination.

{
    "status": "success",
    "data": {
        "server_name": "My Awesome Server",
        "place_id": "123456789",
        "job_id": "abc123def456"
    }
}

{
    "status": "error",
    "message": "No server information found for the given place ID and job ID."
}

fetch('https://api.roshield.net/v1/public/get-server-name', {
    method: 'POST',
    headers: {
        'Authorization': 'your-api-key',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({
        place_id: "123456789",
        job_id: "12345678-1234-1234-1234-123456789000"
    })
})
.then(response => response.json())
.then(data => console.log(data));