List teams

GET

teams

{organizationId}

List teams

curl --request GET \
  --url https://api.squadvault.xyz/v1/teams/{organizationId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.squadvault.xyz/v1/teams/{organizationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "image": "<string>",
      "game": "cs",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "playerCount": 123,
      "players": [
        {
          "id": "<string>",
          "name": "<string>",
          "role": "<string>",
          "mainGame": "cs",
          "nationality": "de",
          "teamRole": "captain",
          "gamerTags": [
            {
              "id": "<string>",
              "organizationId": "<string>",
              "playerId": "<string>",
              "game": "cs",
              "gamerTag": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

x-api-key

string

header

required

Organization API key from Settings → API keys.

Path Parameters

organizationId

string

required

Organization ID. Must match the API key's organization.

Query Parameters

limit

integer

default:50

Required range: 1 <= x <= 250

offset

integer

default:0

Required range: x >= 0

view

enum<string>

default:summary

Use full to include player roster details.

Available options:

summary,

full

Response

Paginated team list

items

object[]

required

Show child attributes

pagination

object

required

Show child attributes

List teams

curl --request GET \
  --url https://api.squadvault.xyz/v1/teams/{organizationId} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.squadvault.xyz/v1/teams/{organizationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "items": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "image": "<string>",
      "game": "cs",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "playerCount": 123,
      "players": [
        {
          "id": "<string>",
          "name": "<string>",
          "role": "<string>",
          "mainGame": "cs",
          "nationality": "de",
          "teamRole": "captain",
          "gamerTags": [
            {
              "id": "<string>",
              "organizationId": "<string>",
              "playerId": "<string>",
              "game": "cs",
              "gamerTag": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z"
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "hasMore": true,
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Guides

Teams

Players

Documents

Tryout Applications

Uploads

Authorizations

Path Parameters

Query Parameters

Response