Teams

Object Types

Tik::Model::Team

{
  "_type": "Tik::Model::Team",
  
  // (ObjectId) The ID of the team
  "_id": "",
  
  // (string, required) name of the team
  "name": "",
  
  // (ObjectId, required) ID of the organization that becomes the new owner of the team
  "owner_id": "",
  
  // (Sportstype, required) identifier of the sportstype
  "sportstype": "",
  
  // (string) Short name to display in constrained environments
  "short_name": "",
  
  // (string) Additional name to distinguish specific teams with the same name (e.g. "U16", "Male", "Female")
  "name_addition": "",
  
  // (ImageRef) Reference to a team logo
  "image": "",
  
  // (ImageRef) Reference to a team photo
  "banner_image": ""
}

Tik::Model::PlayersTeam

This is only relevant vor beach_volleyball and is not supported via the API yet. Please contact our support.

Create a Team

Request: POST /api/v5/write/team/create.json

Query Parameters: (none)

Post Document:

{
  "_type": "Tik::Model::Team",
  
  // (string, required) name of the team
  "name": "",
  
  // (ObjectId, required) ID of the organization that becomes the new owner of the team
  "owner_id": "",
  
  // (Sportstype, required) identifier of the sportstype
  "sportstype": "",
  
  // (string) Short name to display in constrained environments
  "short_name": "",
  
  // (string) Additional name to distinguish specific teams with the same name (e.g. "U16", "Male", "Female")
  "name_addition": "",
  
  // (ImageRef) Reference to a team logo
  "image": "",
  
  // (ImageRef) Reference to a team photo
  "banner_image": ""
}

Success Response: Tik::Model::Team Object

Update a Team

Not all fields can be updated!

Request: POST /api/v5/write/team/update.json

Query Parameters: (none)

Post Document:

{
  "_type": "Tik::Model::Team",
  
  // (ObjectId) The ID of the team
  "_id": "",
  
  // (string, required) name of the team
  "name": "",
  
  // (string) Short name to display in constrained environments
  "short_name": "",
  
  // (string) Additional name to distinguish specific teams with the same name (e.g. "U16", "Male", "Female")
  "name_addition": "",
  
  // (ImageRef) Reference to a team logo
  "image": "",
  
  // (ImageRef) Reference to a team photo
  "banner_image": ""
}

Success Response: Tik::Model::Team Object

Read a Team

Request: GET /api/v5/write/team/show.json

Query Parameters:

  • _id: (ObjectId, required) The ID of the team

Success Response: Tik::Model::Team Object

Search Teams

Request: GET /api/v5/write/team/index.json

Query Parameters:

  • q: (string) Full-text search query
  • sportstype: (Sportstype, optional) Filters tournaments by sportstype
  • archive_id: (ObjectId, optional) Filters tournaments by archive

  • owner_id: (ObjectId, optional) Filters tournaments by owner

  • limit: (int, optional, default: 30) The number of tournaments to return
  • page: (int, optional, default: 1) For pagination

Success Response: Tik::Model::Collection containing Tik::Model::Team Objects