Skip to main content
GET
/
orgs
/
{identifier}
Get an organization profile
curl --request GET \
  --url https://teambattles.gg/api/v1/orgs/{identifier} \
  --header 'Authorization: Bearer <token>'
{
  "organization": {
    "id": "<string>",
    "name": "<string>",
    "isMember": true,
    "createdAt": "<string>",
    "slug": "<string>",
    "tag": "<string>",
    "avatarUrl": "<string>",
    "description": "<string>",
    "bannerUrl": "<string>",
    "isVerified": true,
    "memberCount": 4503599627370495,
    "teamCount": 4503599627370495,
    "wins": 4503599627370495,
    "losses": 4503599627370495,
    "draws": 4503599627370495,
    "matchesPlayed": 4503599627370495
  },
  "timestamp": "<string>"
}

Permission Required

Organization profile reads require orgs.profile.
  • GET /orgs/discover
  • GET /orgs/{identifier}
  • GET /orgs/{identifier}/members
  • GET /orgs/{identifier}/teams
  • GET /orgs/{identifier}/stats
Discovery is neutral: it does not hide organizations the API key owner already belongs to and does not include join-request flags.

Authorizations

Authorization
string
header
required

Send your API key as: Authorization: Bearer tb_

Path Parameters

identifier
string
required

Organization slug or Convex organization ID.

Response

Organization profile.

Envelope containing organization plus a response timestamp.

organization
object
required

API-safe organization profile.

timestamp
string
required

ISO 8601 timestamp.