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

Server

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

GET/ server:read

The server: name, members, Plus, and what this app may do here.

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

Example data:

{
  "id": "1345183757107200000",
  "name": "Liberty County RP",
  "memberCount": 812,
  "plus": true,
  "scopes": [
    "server:read",
    "shifts:read"
  ],
  "tier": "large"
}

GET/channels server:read

Text channels the bot can see.

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

GET/roles server:read

Roles, highest first.

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

GET/features server:read

Which Sample Bot features are switched on.

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