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

Leave of absence

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

GET/loa loa:read

Who is on leave now.

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

GET/loa/requests loa:read

Leave requests waiting for a decision.

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

GET/loa/users/:userId loa:read

Someone's leave history.

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

POST/loa/:id/decide loa:write

Approve or deny a leave request.

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

POST/loa/:id/end loa:write

End someone's leave early.

NameInDescription
id requiredpath
curl -X POST "https://api.samplebot.app/v1/servers/{server id}/loa/{id}/end" \
  -H "Authorization: Bearer $SAMPLE_API_KEY"