{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"fd2a7c58-8413-4e05-8e6a-df8783cb9b5a","name":"Pluto API Docs","description":"Welcome to the Pluto API, giving developers programmatic access to the entities that users interact with using the Pluto web app. For additional information, support, or to utilize the [Pluto R package](https://help.pluto.bio/en/articles/5739131-accessing-pluto-data-programmatically), visit our [help center](https://help.pluto.bio).\n\n# Overview\n\nThe fields on each type of entity are described in more detail on its relevant requests, but here is a quick overview to get you started developing with Pluto:\n\n#### Organizational data models\n\n- **Organization** - A user may optionally belong to an Organization, depending on their account setup.\n- **Team** - Teams are a way to manage Projects and Users. An Organization can have multiple Teams. A User can belong to multiple teams. A Project may be assigned a team.\n- **Project** - Projects are collections of experiments.\n- **Experiment** - Hold data about an experiment including Sample Data, Assay Data, and Attachments. Analyses can be created to explore data and create Plots.\n- **User** - A person that has an account on Pluto. A user can create their own personal **Projects** and **Experiments**.\n    \n\n# Authentication\n\nAuthentication is performed with every API call by sending a header with an API Key (sometimes called an API Token). Lean how to obtain a API Key [here](https://help.pluto.bio/en/articles/5739131-accessing-pluto-data-programmatically).\n\nThe required header in each request is:\n\n`Authorization: Token PLUTO_API_KEY`\n\nEach response to your API calls will only include the resources that the User whose token is being used can access based on their permissions.\n\n# Error Codes\n\nExpected errors and status codes for each request are described on the respective request where relevant.\n\n# User Permissions\n\nUser permissions are returned as an array (`user_permissions`) on several endpoints and control the allowed actions that the user in context has for the relevant object (Organization, Team, Project, or Experiment).\n\nBelow is a subset of the permissions relevant to the public API endpoints described in these docs.\n\n#### Organization permissions\n\n| Permission string | Notes |\n| --- | --- |\n| `own_organization` | Can perform all actions on an Organization |\n| `edit_organization` | Can edit the Organization details, including name, avatar, favorite colors |\n| `create_organization_shareable_projects` | Can create Projects |\n\n#### Team permissions\n\n| Permission string | Notes |\n| --- | --- |\n| `own_team` | Can perform all actions on an Team |\n| `edit_team` | Can edit the Team details, including name and avatar |\n\n#### Project permissions\n\n| Permission string | Notes |\n| --- | --- |\n| `own_project` | Can perform all actions on a Project, and is listed as the owner of the Project in the Manage Sharing menu |\n| `edit_project` | Can edit the Project details, including name, description, and external links |\n| `create_project_experiments` | Can create Experiments in the Project |\n\n#### Experiment permissions\n\n| Permission string | Notes |\n| --- | --- |\n| `own_experiment` | Can perform all actions on an Experiment |\n| `edit_experiment` | Can edit the Experiment details, including name, description, external links. Can create new analyses and plots. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"13896933","team":1457568,"collectionId":"fd2a7c58-8413-4e05-8e6a-df8783cb9b5a","publishedId":"2s83tJGW95","public":true,"publicUrl":"https://docs.pluto.bio","privateUrl":"https://go.postman.co/documentation/13896933-fd2a7c58-8413-4e05-8e6a-df8783cb9b5a","customColor":{"top-bar":"FFFFFF","right-sidebar":"2b2b2B","highlight":"3343AB"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-10-05T02:55:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Prod - API Key","id":"c7122ff3-1275-429c-b367-4a7b8868ce06","owner":"22954319","values":[{"key":"BASE_URL","value":"https://api.pluto.bio","enabled":true},{"key":"API_TOKEN","value":"<PLUTO_API_KEY>","enabled":true,"type":"default"},{"key":"AUTH_HEADER_KEY","value":"Authorization","enabled":true,"type":"default"},{"key":"AUTH_HEADER_VALUE_PREFIX","value":"Token","enabled":true,"type":"default"},{"key":"USER_ACCESS_TOKEN","value":"","enabled":true,"type":"any"},{"key":"USER_REFRESH_TOKEN","value":"","enabled":true,"type":"any"}],"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/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://pluto.bio/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"},{"label":"Prod - API Key","value":"22954319-c7122ff3-1275-429c-b367-4a7b8868ce06"}],"canonicalUrl":"https://docs.pluto.bio/view/metadata/2s83tJGW95"}