Open this on a computer

The Sample Bot API site is made for a computer, where you write code. Visit api.samplebot.app on your computer.

Back to samplebot.app

Sample Bot API

Bot API

Staff team

6 endpoints. Every address starts with https://api.samplebot.app/v1/servers/{server id}.

GET/staff/requests staff:read

Recent calls for staff in game.

curl "https://api.samplebot.app/v1/servers/{server id}/staff/requests" \
  -H "Authorization: Bearer $SAMPLE_API_KEY"

GET/staff/trainings staff:read

Trainings, newest first.

NameInDescription
userIdquerytrainee
limitquery
curl "https://api.samplebot.app/v1/servers/{server id}/staff/trainings" \
  -H "Authorization: Bearer $SAMPLE_API_KEY"

GET/staff/activity-checks staff:read

Activity checks, newest first.

curl "https://api.samplebot.app/v1/servers/{server id}/staff/activity-checks" \
  -H "Authorization: Bearer $SAMPLE_API_KEY"

GET/staff/activity-checks/:id staff:read

One activity check: who answered and who has not.

NameInDescription
id requiredpath
curl "https://api.samplebot.app/v1/servers/{server id}/staff/activity-checks/{id}" \
  -H "Authorization: Bearer $SAMPLE_API_KEY"

GET/roleplay-requests staff:read

Roleplay requests. status=PENDING, APPROVED or DENIED.

NameInDescription
statusquery
curl "https://api.samplebot.app/v1/servers/{server id}/roleplay-requests" \
  -H "Authorization: Bearer $SAMPLE_API_KEY"

POST/roleplay-requests/:id/decide staff:write

Approve or deny a roleplay request.

NameInDescription
id requiredpath
accepted requiredbodytrue or false
curl -X POST "https://api.samplebot.app/v1/servers/{server id}/roleplay-requests/{id}/decide" \
  -H "Authorization: Bearer $SAMPLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"accepted":true}'