{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"40775fac-6401-4d11-8d24-9119bff6f463","name":"Teamworks AMS API - public docs","description":"Welcome to the Teamworks AMS API documentation. This documentation outlines how to use common calls in our various API's.\n\n### Before you begin\n\nThere are some important considerations to take in account before using our API's. Please read through theese before you begin\n\n- The AMS API does not support MFA, SSO, and Terms Documents. If your AMS instance is configured to enforce any of the above, your account must be excempted. This can be done in the admin portal of AMS by any administrator of your instance.\n    \n- When saving anything new, you should set the id field to -1 to indicate it's a new object. Setting it to a specific number might override an existing object.\n    \n- The AMS API repects all the same permissions as if you were interacting with the AMS web or mobile apps. For example, if you don’t have access to a particular form in the AMS, you won’t have access to that form via the API. If you are running into access issues, speak to an administrator of your site\n    \n- The API is a powerful tool and so please take care to consider what it is you are building and testing extensively. In cases of incorrect use of the API, we may not be able to provide support\n    \n\n### API v1, v2 and v3\n\nAMS has 3 API's, each with slightly different designs and purposes. Each call in this collection specifies which version of the API it is using and will outline the specific structure of the endpoint and payloads required. Please pay careful attention to the Authentication section since this differs between each of the APIs\n\n# Getting Started\n\n## Step 1: Get appropriate access to your AMS site\n\nThe first step is to have an appropriate account. You will need an account with Coach access to all site users and Read and Write access to all forms you wish to use. Using an Administrator and Builder account is convenient but optional for the most part. This documentation will specifically call out when Administrator or Builder access is required for any endpoints.\n\n## Step 2: Fork the collection using Run in Postman\n\n<img src=\"https://content.pstmn.io/6416a243-6f3c-47f0-9df8-a0ba92b2be71/aW1hZ2UucG5n\" width=\"128\" height=\"32\">\n\n## Step 3: Setup the Postman environment\n\nEnvironment variables are used to update the various API calls with variables specific to your environment. You should see an example variable that you can either edit or duplcate to update to your own.\n\n<img src=\"https://content.pstmn.io/2e0dccfa-43e2-4ee4-9cab-e624370a9c1b/Q2xlYW5TaG90IDIwMjQtMDgtMTMgYXQgMTUuNDMuMTQucG5n\" width=\"468\" height=\"166\">\n\nYou should update both the initial and current value of each of the following\n\n- `amsServer`: set this to the 'server\" part of the your URL (**smartabase.server.com**/site)\n    \n- `amsAppName:` set this to the \"site\" part of the your URL (smartabase.server.com/**site**)\n    \n- `amsURL`: this should be set automatically, don't change anything\n    \n- `username`: enter your AMS username\n    \n- `password`: enter your AMS password\n    \n- `session` : leave blank\n    \n- `X-APP-ID`: add some kind of unique identifier that allows us to provide support by knowing it was you making these calls.\n    \n\n## Step 4: Make your first call\n\nMake your first call. We reccomend authenticating using v1 to test that your connection is working.\n\nSee [(v1) Authenticate User](https://team-smartabase.postman.co/workspace/AMS-API-Documentation~d040e081-76cd-4ddd-9b5b-ed25f9324c32/request/31794560-f45a6e80-69ad-46b9-85e1-d478227b6413?action=share&source=copy-link&creator=31794560&ctx=documentation)\n\n## Further Reading\n\nTeamworks' AMS is a complex product with many features. It is also a no-code platform, so the version you are working with has undoubtedly been used to create bespoke data structures, calculations, and workflows. For example, your end users may have asked you to retrieve \"Training Sessions\" or \"Athlete Classifications.\" You will not find these terms in this documentation or anywhere in the API because, as far as the AMS is concerned, it is all just Events stored in Event Forms with some labels configured by your organization.\n\nThis can be hard to understand without a UI to guide you. Therefore, reviewing the \"AMS Fundamentals\" course is highly recommended. It is free, designed to take no more than two hours, and you will be glad you gave it a go! See more information here: [AMS Fundamentals](https://academy.smartabase.com/teamworks-ams-fundamentals).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"31794560","team":5415727,"collectionId":"40775fac-6401-4d11-8d24-9119bff6f463","publishedId":"2sA3rzJs2V","public":true,"publicUrl":"https://documenter-api.postman.tech/view/31794560/2sA3rzJs2V","privateUrl":"https://go.postman.co/documentation/31794560-40775fac-6401-4d11-8d24-9119bff6f463","customColor":{"top-bar":"FFFFFF","right-sidebar":"0A0A0F","highlight":"009657"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"0A0A0F","right-sidebar":"0A0A0F","highlight":"009657"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"0A0A0F","highlight":"009657"}}]}},"version":"8.10.0","publishDate":"2024-08-13T05:42:19.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Teamworks AMS API - public docs examples","id":"06283afe-209a-4fab-ae28-796f6c3ab8da","owner":"31794560","values":[{"key":"amsServer","value":"https://server.smartabase.com","enabled":true,"type":"default"},{"key":"amsAppName","value":"site","enabled":true},{"key":"amsURL","value":"{{amsServer}}/{{amsAppName}}","enabled":true},{"key":"username","value":"username","enabled":true},{"key":"password","value":"password","enabled":true,"type":"secret"},{"key":"session","value":"","enabled":true,"type":"secret"},{"key":"X-APP-ID","value":"external.example.postman","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/5a426f689f71247bf502cc5617c3ac17cd7658d3f8bdcfb8fed15c51d95d99ba","favicon":""},"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":"Teamworks AMS API - public docs examples","value":"31794560-06283afe-209a-4fab-ae28-796f6c3ab8da"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA3rzJs2V"}