skip to content
superbot.gg

Get a team

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

GET /v1/teams/{team_id}

One team the caller is a member of, with the caller’s own role.

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

Operation id getTeam in Teams.

Path parameters

  • team_id string required

    The team id.

Response 200

The team.

application/json: Team.

  • id string required
  • object string required

    One of team.

  • name string required
  • role TeamRole required

    The caller's role in this team. One of owner, admin, editor, member.

  • member_count integer required
  • created_at string required
  • share_defaults object required

    What a new member pools by default, per kind.

    3 fields
    • mcp boolean required
    • rules boolean required
    • skills boolean required
  • share_policy string required

    Who may add items to the pool. One of members, editors.

  • require_manual_confirm boolean required

Errors

StatusCodeWhat to change
401unauthorized

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.

403insufficient_scope

The key lacks the scope in required_scopes; mint a key that holds it.

404not_found

No such resource on this account; check the id.

view .mdopenapi
Request

curl

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

JavaScript

const teamId = 'TEAM_ID';
const res = await fetch(`https://superbot.gg/v1/teams/${teamId}`, {
  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}",
    headers={
        "Authorization": f"Bearer {os.environ['SUPERBOT_API_KEY']}",
    },
)
print(res.status_code, res.json())
Response

200 The team.

{
  "id": "org_7c1e…",
  "object": "team",
  "name": "your-name",
  "role": "owner",
  "member_count": 0,
  "created_at": "your-created-at",
  "share_defaults": {
    "mcp": true,
    "rules": true,
    "skills": true
  },
  "share_policy": "members",
  "require_manual_confirm": true
}

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"
}