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

Tickets

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

GET/tickets tickets:read

Tickets. Open and claimed by default; status=CLOSED for closed ones.

NameInDescription
statusqueryOPEN, CLAIMED or CLOSED
userIdquery
limitquery
curl "https://api.samplebot.app/v1/servers/{server id}/tickets" \
  -H "Authorization: Bearer $SAMPLE_API_KEY"

GET/tickets/stats tickets:read

Counts: open, claimed, closed this week.

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

GET/tickets/:id tickets:read

One ticket.

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

POST/tickets/:id/claim tickets:write

Claim a ticket as a staff member. Their own permissions are checked.

NameInDescription
id requiredpath
userId requiredbodythe staff member
curl -X POST "https://api.samplebot.app/v1/servers/{server id}/tickets/{id}/claim" \
  -H "Authorization: Bearer $SAMPLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userId":"1246251869798400001"}'

POST/tickets/:id/unclaim tickets:write

Let a claimed ticket go.

NameInDescription
id requiredpath
userId requiredbody
curl -X POST "https://api.samplebot.app/v1/servers/{server id}/tickets/{id}/unclaim" \
  -H "Authorization: Bearer $SAMPLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userId":"1246251869798400001"}'

POST/tickets/:id/close tickets:write

Close a ticket with a transcript, as a staff member allowed to.

NameInDescription
id requiredpath
userId requiredbody
reasonbody
curl -X POST "https://api.samplebot.app/v1/servers/{server id}/tickets/{id}/close" \
  -H "Authorization: Bearer $SAMPLE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userId":"1246251869798400001"}'