Developers

Connect your Roblox game and your own tools to your workspace. Everything here works with a workspace API key.

Getting started

Make an API key in your workspace's admin centre, under Developers › API keys. Open Rosterr
Send it with every request as: Authorization: Bearer rstr_…
Each key can make 600 requests a minute. Slow down if you get a 429.

curl https://api.rosterr.work/v1/game/workspace \
  -H "Authorization: Bearer rstr_your_key"

Keep keys on your game server or your own server, never in a LocalScript or a website. Anyone with the key can act as your workspace.

Reference

GET /v1/game/workspace Which workspace this key belongs to
POST /v1/game/heartbeat A game server is running. Send every minute so Admin centre > Game shows it as connected.
POST /v1/game/shutdown A game server is closing. Removes it from the connected list straight away.
GET /v1/game/hiring/jobs The workspace's job listings and how many applications each has
GET /v1/game/hiring/applications Applications, newest first, optionally only those since a time
GET /v1/game/members/{robloxUserId} A player's roles and permissions, for in-game checks
GET /v1/game/bans/{robloxUserId} Whether a player is banned, for kicking them as they join
POST /v1/game/activity/join Players joined the game. Starts tracking their time.
POST /v1/game/activity/leave Players left the game. Stops tracking their time.
POST /v1/game/activity/idle Players have been idle for the workspace's idle time. Their time stops at the moment they went idle; send /activity/join when they move again.
POST /v1/game/orders A staff member served an order. Counts towards their orders on the leaderboard.
GET /v1/game/staff/{robloxUserId} What the in-game staff panel shows: this week's activity against the quota, what the player may do, and the sessions they host today
POST /v1/game/cases A staff member files a moderation case against a player in game. They need moderation.act, the same as in the app.
POST /v1/game/sessions A staff member starts a session now, in this server. They need sessions.host. Others see it in Sessions and can sign up.
POST /v1/game/logs/admin Someone ran an admin command in the game. Shown in Moderation > Game logs for 90 days.
POST /v1/game/logs/chat Chat messages from a game server, posted to Discord webhooks that want game chat. Rosterr does not keep them. Send the text after Roblox has filtered it.

GET `/v1/game/workspace`

Which workspace this key belongs to

Response

Field	Type
`slug`	string
`name`	string
`robloxGroupId`	string
`idleMinutes`	number

POST `/v1/game/heartbeat`

A game server is running. Send every minute so Admin centre > Game shows it as connected.

Request body

Field	Type
`serverId`	string
`placeId` (optional)	string
`players`	integer
`moduleVersion` (optional)	string

Response

Field	Type
`everySeconds`	number
`latestVersion`	string

POST `/v1/game/shutdown`

A game server is closing. Removes it from the connected list straight away.

Request body

Field	Type
`serverId`	string

Answers 204 with no body when it works.

GET `/v1/game/hiring/jobs`

The workspace's job listings and how many applications each has

Response

Field	Type
`id`	string (uuid)
`title`	string
`jobType`	string
`visibility`	string
`state`	one of: open, closed, full
`applications`	number
`closesAt`	string (date-time) or null
`url`	string or null

GET `/v1/game/hiring/applications`

Applications, newest first, optionally only those since a time

Parameters

jobId in the query string · string (uuid) · (optional)
since in the query string · string (date-time) · (optional)

Response

Field	Type
`id`	string (uuid)
`jobId`	string (uuid)
`job`	string
`status`	string
`robloxUserId`	string or null
`robloxUsername`	string or null
`createdAt`	string (date-time)

GET `/v1/game/members/{robloxUserId}`

A player's roles and permissions, for in-game checks

Parameters

robloxUserId in the address · string

Response

Field	Type
`member`	boolean
`rank`	number or null
`roles`	string[]
`departments`	string[]
`permissions`	string[]

GET `/v1/game/bans/{robloxUserId}`

Whether a player is banned, for kicking them as they join

Parameters

robloxUserId in the address · string

Response

Field	Type
`banned`	boolean
`case`	object or null
`case.number`	number
`case.reason`	string
`case.expiresAt`	string (date-time) or null

POST `/v1/game/activity/join`

Players joined the game. Starts tracking their time.

Request body

Field	Type
`robloxUserIds`	string[]

Response

Field	Type
`tracked`	number
`unknown`	string[]

POST `/v1/game/activity/leave`

Players left the game. Stops tracking their time.

Request body

Field	Type
`robloxUserIds`	string[]

Response

Field	Type
`tracked`	number
`unknown`	string[]

POST `/v1/game/activity/idle`

Players have been idle for the workspace's idle time. Their time stops at the moment they went idle; send /activity/join when they move again.

Request body

Field	Type
`robloxUserIds`	string[]

Response

Field	Type
`tracked`	number
`unknown`	string[]

POST `/v1/game/orders`

A staff member served an order. Counts towards their orders on the leaderboard.

Request body

Field	Type
`robloxUserId`	string
`customerName` (optional)	string
`items`	object[]
`items[].name`	string
`items[].quantity`	integer

Response

Field	Type
`id`	string (uuid)

GET `/v1/game/staff/{robloxUserId}`

What the in-game staff panel shows: this week's activity against the quota, what the player may do, and the sessions they host today

Parameters

robloxUserId in the address · string

Response

Field	Type
`minutes`	number
`quota`	number or null
`excused`	boolean
`canModerate`	boolean
`canHost`	boolean
`sessions`	object[]
`sessions[].id`	string (uuid)
`sessions[].title`	string
`sessions[].startsAt`	string (date-time)

POST `/v1/game/cases`

A staff member files a moderation case against a player in game. They need moderation.act, the same as in the app.

Request body

Field	Type
`staffRobloxUserId`	string
`target`	object
`target.robloxUserId`	string
`target.name`	string
`action`	one of: note, warning, kick, temp_ban, ban
`reason`	string
`durationHours` (optional)	integer

Response

Field	Type
`number`	number
`expiresAt`	string (date-time) or null

POST `/v1/game/sessions`

A staff member starts a session now, in this server. They need sessions.host. Others see it in Sessions and can sign up.

Request body

Field	Type
`staffRobloxUserId`	string
`title`	string
`kind` (optional)	one of: training, shift, event, meeting
`durationMinutes` (optional)	integer
`serverId` (optional)	string

Response

Field	Type
`id`	string (uuid)

POST `/v1/game/logs/admin`

Someone ran an admin command in the game. Shown in Moderation > Game logs for 90 days.

Request body

Field	Type
`actor`	object
`actor.robloxUserId`	string
`actor.name`	string
`command`	string
`target` (optional)	object
`target.robloxUserId` (optional)	string
`target.name`	string
`details` (optional)	string
`serverId` (optional)	string

Response

Field	Type
`id`	string (uuid)

POST `/v1/game/logs/chat`

Chat messages from a game server, posted to Discord webhooks that want game chat. Rosterr does not keep them. Send the text after Roblox has filtered it.

Request body

Field	Type
`serverId` (optional)	string
`messages`	object[]
`messages[].robloxUserId`	string
`messages[].name`	string
`messages[].text`	string

Response

Field	Type
`forwarded`	boolean

Developers

Getting started

Reference

GET /v1/game/workspace

Response

POST /v1/game/heartbeat

Request body

Response

POST /v1/game/shutdown

Request body

GET /v1/game/hiring/jobs

Response

GET /v1/game/hiring/applications

Parameters

Response

GET /v1/game/members/{robloxUserId}

Parameters

Response

GET /v1/game/bans/{robloxUserId}

Parameters

Response

POST /v1/game/activity/join

Request body

Response

POST /v1/game/activity/leave

Request body

Response

POST /v1/game/activity/idle

Request body

Response

POST /v1/game/orders

Request body

Response

GET /v1/game/staff/{robloxUserId}

Parameters

Response

POST /v1/game/cases

Request body

Response

POST /v1/game/sessions

Request body

Response

POST /v1/game/logs/admin

Request body

Response

POST /v1/game/logs/chat

Request body

Response

GET `/v1/game/workspace`

POST `/v1/game/heartbeat`

POST `/v1/game/shutdown`

GET `/v1/game/hiring/jobs`

GET `/v1/game/hiring/applications`

GET `/v1/game/members/{robloxUserId}`

GET `/v1/game/bans/{robloxUserId}`

POST `/v1/game/activity/join`

POST `/v1/game/activity/leave`

POST `/v1/game/activity/idle`

POST `/v1/game/orders`

GET `/v1/game/staff/{robloxUserId}`

POST `/v1/game/cases`

POST `/v1/game/sessions`

POST `/v1/game/logs/admin`

POST `/v1/game/logs/chat`