{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"71d38662-3128-43af-8aa6-0c34bda0e8da","name":"Cytobank API Endpoint Reference","description":"The Cytobank API is a RESTful JSON web API that extends use of basic and advanced functionality of the Cytobank Cloud to any software application. [Learn more about the Cytobank API](https://support.cytobank.org/hc/en-us/articles/206336157-Overview-of-the-Cytobank-API).\n\nThis v1 API endpoint reference documentation provides information and low-level instructions for access to each API endpoint via HTTP request. Higher level wrappers in programming languages such as R are available [here](https://support.cytobank.org/hc/en-us/articles/115001546727-Cytobank-API-Libraries-for-Programming-Languages).\n\nIf an endpoint can't be found on this page it doesn't exist yet. The Cytobank API is under continuous development. Look for exciting releases in the near future. [Get in contact with Cytobank Support](https://support.cytobank.org/hc/en-us) to request additional endpoints or get beta access to new API functionality.\n\n# Documentation Overview\n\nCytobank API endpoints are divided into different groups in this reference guide. These groups logically separate the different functionalities of Cytobank and the API endpoints that serve them. In order to find a functionality of interest, first consult the groups on the left for relevance. Click to expand a group in order to see the API endpoints inside it. Make sure to start with the **Authentication** section.\n\nView an endpoint in this documentation for directions on how to access it via HTTP request and to read useful supporting information. The HTTP method (e.g. POST, GET, etc.), headers, example body, and example responses are shown where relevant.\n\n## Code Snippets\n\nCode snippets in a variety of programming languages are shown for each request. The language shown can be adjusted at the top right of this page. Copy the snippets and execute them in the desired language in order to try the API in a simple context. Please note that code snippets are automatically generated and it's possible that not every snippet will work in every language. The exception to this are requests in cURL, which are all expected to work.\n\n## Replacing Bracketed Variables\n\nCapitalized variables in double brackets, {{LIKE_THIS}}, should be replaced with actual values if examples from this documentation are being used directly. These bracketed variables appear throughout the documentation. For example:\n\n[https://{{CYTOBANK}}.cytobank.org/cytobank/api/v1/authenticate](https://{{CYTOBANK}}.cytobank.org/cytobank/api/v1/authenticate)  \n...would become...  \n[https://YourCytobank.cytobank.org/cytobank/api/v1/authenticate](https://YourCytobank.cytobank.org/cytobank/api/v1/authenticate)\n\n\"username\": \"{{user_name}}\", \"password\": \"{{userpassword}}\"  \n...would become...  \n\"username\": \"YourUsername\", \"password\": \"YourPassword\"\n\n# Rate Limiting\n\nCurrently the Cytobank API has a default rate limit of 100 requests per 1 minute. If this rate is exceeded the server will respond with a 429 status code and an error message about the rate limits. Requests are binned per minute according to the clock on the server.\n\n# Error Codes and Messages\n\nThe Cytobank API will respond to requests with a HTTP status code and return content via JSON. In the case of an error, a status code will be accompanied by a useful message where possible. A variety of status codes are used and not all will be listed here. However, at a high level, anything in the 200 range indicates success, 400 range indicates a client-side error such as a malformatted request or disallowed operation, and 500 range indicates a server-side error. Keep in mind that Cytobank has a permissions framework that the API adheres to. If an error message of **Not Authorized To Access Resource** is encountered, double check the accessing account has proper access levels for the desired operation, or clone the experiment in question to make an accessible copy.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1066072","team":13568,"collectionId":"71d38662-3128-43af-8aa6-0c34bda0e8da","publishedId":"RzZCEdPs","public":true,"publicUrl":"https://developer.cytobank.org","privateUrl":"https://go.postman.co/documentation/1066072-71d38662-3128-43af-8aa6-0c34bda0e8da","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2018-11-16T00:23:21.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/5052fe0f44fdf9c73143811cf3f755766915ad33493458f80ec99b3ec1b6ae62","favicon":"https://res.cloudinary.com/postman/image/upload/v1625765089/team/imm7g8nqbhyabygi47kc.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://developer.cytobank.org/view/metadata/RzZCEdPs"}