{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"45aea964-bb3e-2c92-dd7b-b14af49042d3","name":"Test Collab API","description":"\n##  These API docs are for  TestCollab Classic, if you signed up after 26th Jan 2021 then you are using TestCollab 2, api docs for TestCollab 2 can be found here- <https://developers.testcollab.com/>\n\n\n---\n<br/>\n\n<br/>\n\nAn API key is required to make API calls. The key is automatically created when a user is added, to obtain it, login to your Test Collab account and go to 'Profile' page.\n\n<h3>Authentication</h3>\n\nA request can be of a simple 'GET' or 'POST' type depending upon the action. 'API_KEY' should always be appended as 'GET' variable for authentication.\n\n\n<h3>Prerequisites</h3>\n\nAn API key is required to make API calls. The key is automatically created when a user is added, to obtain it, login to your Test Collab account and go to 'Profile' page.\n\n<h3>Request Parameters</h3>\n\nA request can be of a simple 'GET' or 'POST' type depending upon the action. 'API_KEY' should always be appended as 'GET' variable for authentication.\n\n<b>Sample URL:</b>\n\n<div class=\"url\">\nhttp://your-testcollab-url.com/index.php/projects/index.json?API_KEY=0123456789\n</div>\n\n<b>Parameters Breakdown:</b>\n\n<pre>\n{{base_url}}\n</pre>\nThis is the base URL of your Test Collab setup \n\nSample Value (in case of above URL): http://your-testcollab-url.com/index.php\n\n<pre>\n{{api_key}} \n</pre>\nThis is your API key for Test Collab account. This is user-specific.\nSample Value (in case of above URL): 0123456789\n\n \n<b>Note about pagination</b>\n\nIf you are calling the index action for an entity then API returns paginated results, for this the request should have following  template \n\nhttps://your-testcollab-url.com/index.php/project/{project_id}/test_cases/index/{test_suite_id}/page:1/limit:30.json\n\nYou can adjust 'page' or 'limit' variables as per your needs.\n\n<h3>Response Parameters</h3>\nEverytime a request is made to API, it will reply with a JSON-formatted string like this:\n<pre>\n\n{\n    \"appState\": \"/project/7\", \n    \"data\": {\n        \"created_id\": \"7\"\n    }, \n    \"message\": \"Project added.\", \n    \"status\": true\n}\n</pre>\n<b>Parameters</b>\n\nParameter\tPossible Values\tDescription\nstatus\t(true / false)\tStatus of the requested action. 'true' means action was completed successfully. 'false' means failure of request for any reason.\n\nmessage\tnull / string\tThe success or error message.\n\ndata.created_id \tnull / integer\tThis returns the ID of newly created item as a request of API request. 'created_id' will be returned as null on all other actions except 'add' actions.\n\ndata.errors\tabsent / JSON object\tIf 'status' is returned false, this will usually show the reason why request was failed. It may also contain validation errors.\n\ndata.*\tabsent / JSON object\tDepending upon the requested action, this will contain one or more action-specific parameters.\n\nappState\tabsent / string\tThis tells you where the system redirects the end-user after the requested action is finished. This can be used to build custom UI clients with API.\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1488819","collectionId":"45aea964-bb3e-2c92-dd7b-b14af49042d3","publishedId":"RVnTkLze","public":true,"publicUrl":"https://api.testcollab.com","privateUrl":"https://go.postman.co/documentation/1488819-45aea964-bb3e-2c92-dd7b-b14af49042d3","customColor":{"top-bar":"0D2F53","right-sidebar":"303030","highlight":"2370AA"},"documentationLayout":"classic-double-column","version":"8.11.6","publishDate":"2018-04-18T14:47:28.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://testcollab.com/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://api.testcollab.com/view/metadata/RVnTkLze"}