{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3ca1d016-078a-4e2c-b40b-c2eece7ec25d","name":"API 1.0","description":"<img src=\"https://files.teamsportz.app/assets/api_documentation/api_banner.jpeg\">\n\n## Welcome to TeamSportz sports platform API\n\n**You can find here general technical information about the TeamSportz API to enables you programmatically integrate your app or application with the TeamSportz sports platform.**\n\n**What is an API (Application Programming Interface)?**\n\nAPIs act as a bridge between a server and the application interface. When you request specific information from a mobile or web application, a message is transmitted to the server. The API facilitates server-to-application communication by defining a set of principles and a structured data format. The type of API used by TeamSportz is the RESTfull API.\n\n**What is the REST (Representational State Transfer) API?**\n\nThis type of API is accessed via an HTTP (Hypertext Transfer Protocol) request by executing various actions on a URL (Uniform Resource Locator) containing resources such as GET, POST, DELETE, and PUSH.\n\nThe API enables your to fully manage your Club, Teams, Coaches and Players as well as a variety of services and features of the platform. Note that the API has been designed to covers a variety of use cases such as sports clubs and sports organisations, Gyms and or fitness trainers. If your particular case study is not covered here please contact [hello@teamportz.pro](https://mailto:hello@teamportz.pro)\n\nWith exception of the registration, all requests to the TeamSportz API require authentication. It's fundamental to understand that TeamSportz API has two sides:**\n\n- **Players** (users)\n    \n- **Club Management** (admin)\n    \n\nBy starting with the Registration endpoints you will be on your way to start consume TeamSportz platform services. However, to use the Club Management endpoints you need a 3rd Party API Secrete Key. Request your 3rd Party API Key at [dev@teamsportz.pro](https://mailto:dev@teamsportz.pro)\n\nThis documentation will guide you through the each endpoint and what a response will look like. All endpoints have been grouped by their respective domain. For example Players or Videos, etc.\n\nDepending on the role or authorization scope, endpoints might have different responses. TeamSportz API assumes the following Roles:\n\n- **Individual Player** (user - not associated to a Team)\n    \n- **Team Player** (user - associated to a Team)\n    \n- **Coach** (manager)\n    \n- **Head Coach** (admin - attached to billing)\n    \n\nIf you have any technical questions please write to [dev@teamsportz.pro](https://mailto:dev@teamsportz.pro) if you have business or partnership questions please write to [hello@teamsportz.pro](https://mailto:hello@teamsportz.pro).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"15119005","team":1692390,"collectionId":"3ca1d016-078a-4e2c-b40b-c2eece7ec25d","publishedId":"UVeCP7xb","public":true,"publicUrl":"https://documentation.teamsportz.pro","privateUrl":"https://go.postman.co/documentation/15119005-3ca1d016-078a-4e2c-b40b-c2eece7ec25d","customColor":{"top-bar":"FFFFFF","right-sidebar":"06050f","highlight":"fc5352"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-07-31T10:04:35.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Staging","id":"7390c73b-79cd-488a-b1e3-432083a676c9","owner":"15119005","values":[{"key":"baseUrl","value":"https://api-test.teamsportz.pro","enabled":true,"type":"default"},{"key":"bearerToken","value":"","enabled":true,"type":"secret"},{"key":"version","value":"v1","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/161662838282f87535f3866a8d654e33192887533dc6aa81ad6d7b0a9af86f48","favicon":"https://res.cloudinary.com/postman/image/upload/v1616684941/team/mo3wupeqe2lvdb6wh0n6.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Staging","value":"15119005-7390c73b-79cd-488a-b1e3-432083a676c9"}],"canonicalUrl":"https://documentation.teamsportz.pro/view/metadata/UVeCP7xb"}