List pending team invites

Part of Teams, 14 operations. The overview covers keys, scopes and errors.

GET /v1/teams/{team_id}/invites

Invites not yet accepted, revoked or expired, paged by invite code in the order they were sent. Admins and owners only.

A caller key holding teams:read (Authorization: Bearer sbc_… or x-api-key: sbc_…), or a signed-in session.

Operation id listTeamInvites in Teams.

Path parameters

team_id string required
The team id.

Query parameters

limit integer optional
Items per page, 1-100.
after_id string optional
Return the page after this resource id (the previous page’s last_id).
before_id string optional
Return the page before this resource id (the next page’s first_id).

Response 200

One page of invites.

application/json: TeamInviteList.

object string required
One of list.
data array of TeamInvite required
6 fields
- object string required
  One of team_invite.
- code string required
- email string required
- role TeamRole required
  The caller's role in this team. One of owner, admin, editor, member.
- created_at string required
- expires_at string
has_more boolean required
first_id string | null required
Id of the first item on this page; pass as before_id for the previous page.
last_id string | null required
Id of the last item on this page; pass as after_id for the next page.

Errors

Status	Code	What to change
400	`invalid_request`	A parameter or body field is invalid; `param` names it and `issues` lists every problem.
401	`unauthorized`	Send a live caller key or session as `Authorization: Bearer …` or `x-api-key`. No key yet: create one at /account/api, or sign a user in at /auth.md.
403	`insufficient_scope`	The key lacks the scope in `required_scopes`; mint a key that holds it.
404	`not_found`	No such resource on this account; check the id.

view .md openapi

Request

curl

curl -sS -X GET "https://superbot.gg/v1/teams/$TEAM_ID/invites" \
  -H "Authorization: Bearer $SUPERBOT_API_KEY"

JavaScript

const teamId = 'TEAM_ID';
const res = await fetch(`https://superbot.gg/v1/teams/${teamId}/invites`, {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SUPERBOT_API_KEY}`,
  },
});
console.log(res.status, await res.json());

Python

import os
import requests

team_id = "TEAM_ID"
res = requests.request(
    "GET",
    f"https://superbot.gg/v1/teams/{team_id}/invites",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
    },
)
print(res.status_code, res.json())

Response

200 One page of invites.

{
  "object": "list",
  "data": [
    {
      "object": "team_invite",
      "code": "your-code",
      "email": "[email protected]",
      "role": "owner",
      "created_at": "your-created-at",
      "expires_at": "your-expires-at"
    }
  ],
  "has_more": true,
  "first_id": "your-first-id",
  "last_id": "your-last-id"
}

400 The request is malformed or a parameter is invalid; `param` names the field.

{
  "error": "invalid_request",
  "message": "A parameter or body field is invalid; param names it and issues lists every problem.",
  "doc_url": "https://superbot.gg/developers#errors-invalid_request",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

401 The bearer is missing, malformed or unknown.

{
  "error": "unauthorized",
  "message": "Send a live caller key or session as Authorization: Bearer … or x-api-key. No key yet: create one at /account/api, or sign a user in at /auth.md.",
  "doc_url": "https://superbot.gg/developers#errors-unauthorized",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

403 The key lacks a scope (insufficient_scope), is revoked, or may not call this route.

{
  "error": "insufficient_scope",
  "message": "The key lacks the scope in required_scopes; mint a key that holds it.",
  "doc_url": "https://superbot.gg/developers#errors-insufficient_scope",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}

404 No such resource on this account.

{
  "error": "not_found",
  "message": "No such resource on this account; check the id.",
  "doc_url": "https://superbot.gg/developers#errors-not_found",
  "request_id": "req_5f1c0a9e2b7d4c3a1e0f9b8d"
}