{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"5b9c033c-5215-4d05-8aad-e968316ce4d3","name":"TEAMS Public-API","description":"# **Overview**\n\nWe have launched a new project called **Public API**, allowing users to connect their systems with our services. This API includes **SEARCH, GET, PUT, and POST** routes, making it easy to find, retrieve, update, and add data.\n\n## How to Generate a Token for Authorization\n\n- Obtain your `clientId` and `clientSecret` from **UserEntry Screen**.\n    \n- Convert `clientId:clientSecret` to **Base64** using an online tool ([https://www.base64encode.org/](https://www.base64encode.org/)) or programmatically.\n    \n- Send a request with the encoded Base64 string in the headers :\n    \n    - Authorization **: Basic (Generated Base64 String).**\n        \n- Include the token in API requests.\n    \n\n## H**ow to Use the API**\n\n### **1\\. Authentication**\n\n- Every request needs an Authorization: Bearer TOKEN.\n    \n\n### **2\\. Request Format**\n\n- All data should be in **JSON format**.\n    \n\n``` json\n{ \"name\": \"Example Item\", \"description\": \"This is a test item\"}\n\n ```\n\n### **3\\. Error Messages**\n\n- `200 OK` – Everything worked.\n    \n- `400 Bad Request` – Something is wrong with the request.\n    \n- `401 Unauthorized` – API key is missing or incorrect.\n    \n- `404 Not Found` – Item doesn’t exist.\n    \n- `500 Internal Server Error` – Server issue.\n    \n\n## **API Endpoints**\n\n### **1\\. SEARCH (Find Data)**\n\n- **Route:** `GET /public/students?searchString=Smith&createdFrom=2025-01-02&createdTo=2025-01-30&changedFrom=2025-01-15&changedTo=2026-08-20&includeInactive=true`\n    \n- **What it does:** Lets users search for specific data.\n    \n- **What you need to send:**\n    \n    - `searchString` (text) – The keyword to search for.\n        \n    - `createdFrom` (text, optional) – Date to filter records created from this date.\n        \n    - `createdTo` (text, optional) – Date to filter records created up to this date.\n        \n    - `changedFrom` (text, optional) – Date to filter records changed from this date.\n        \n    - `changedTo` (text, optional) – Date to filter records changed up to this date.\n        \n    - `pageNumber` (number, default: 1) – Page number to retrieve.\n        \n    - `pageSize` (int, default: 100) – Number of records per page.\n        \n    - `includeInactive` (boolean, default: false) – Include inactive records in the results.\n        \n- **Valid date formats:** Use ISO 8601: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss\n    \n- **What you get:** A list of matching data in JSON format.\n    \n\n### **2\\. GET (Retrieve Data)**\n\n- **Route:** `GET /public/students/{id}`\n    \n- **What it does:** Fetches details of a specific item.\n    \n- **What you need to send:**\n    \n    - `{id}` – The unique ID of the item.\n        \n- **What you get:** A JSON object with item details.\n    \n\n### **3\\. PUT (Update Data)**\n\n- **Route:** `PUT /public/students/{id}`\n    \n- **What it does:** Updates an existing item.\n    \n- **What you need to send:**\n    \n    - `{id}` – The unique ID of the item.\n        \n    - JSON data with updated details.\n        \n- **What you get:** A success message and updated item details.\n    \n\n### **4\\. POST (Add New Data)**\n\n- **Route:** `POST /public/students`\n    \n- **What it does:** Creates a new item.\n    \n- **What you need to send:**\n    \n    - JSON data with new item details.\n        \n- **What you get:** A success message and the new item’s ID\n    \n\n## **What Can You Do with This API?**\n\n- Connect your system with our platform.\n    \n- Search, retrieve, update, and add data easily.\n    \n- Automate processes in your application.\n    \n- Ensure fair usage with rate limits.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"17939692","team":6422273,"collectionId":"5b9c033c-5215-4d05-8aad-e968316ce4d3","publishedId":"2sAYXFjHxC","public":true,"publicUrl":"https://apidocs.rtoteams.com.au","privateUrl":"https://go.postman.co/documentation/17939692-5b9c033c-5215-4d05-8aad-e968316ce4d3","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2662C5"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/01f1ad49-80b0-482f-a7f6-579eeca2de53/VGVhbXNMb2dvICgxKS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"2662C5"}},{"name":"light","logo":"https://content.pstmn.io/1647474c-ecc9-4cce-8d5b-1be9a173cbc2/VGVhbXNMb2dvICgxKS5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2662C5"}}]}},"version":"8.10.1","publishDate":"2025-10-13T10:28:23.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/1647474c-ecc9-4cce-8d5b-1be9a173cbc2/VGVhbXNMb2dvICgxKS5wbmc=","logoDark":"https://content.pstmn.io/01f1ad49-80b0-482f-a7f6-579eeca2de53/VGVhbXNMb2dvICgxKS5wbmc="}},"statusCode":200},"environments":[],"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/4a1c2b209699669c0564f445d372ccb34c088ea5e6736c10de260e3c32aa2679","favicon":"https://rtoteams.com.au/favicon.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"}],"canonicalUrl":"https://apidocs.rtoteams.com.au/view/metadata/2sAYXFjHxC"}