{"_id":"5b0e13ffc4664e0003c75c1d","category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"parentDoc":null,"version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"project":"5b0e13ffc4664e0003c75a66","user":"554340dfb7f4540d00fcef1d","__v":0,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T20:40:29.403Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[]},"settings":"","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":true,"order":14,"body":"This call returns a list of all projects you are a member of. Each project's `project_id` and URL on the Platform will be returned. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/projects\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/projects HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X GET \\\"https://f4c-api.sbgenomics.com/v2/projects\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n<span style=\\\"color:red\\\"><i>required</i></span>\",\n    \"0-1\": \"Your Platform[authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\",\n    \"1-0\": \"`offset`\",\n    \"2-0\": \"`limit`\",\n    \"1-2\": \"The zero-based starting index in the entire collection of the first item to return. The default value is 0. This is a pagination-specific attribute.\",\n    \"2-2\": \"The maximum number of collection items to return for a single request. Minimum value is 1. The maximum value is 100 and the default value is 25. This is a pagination-specific attribute.\",\n    \"1-1\": \"integer\",\n    \"2-1\": \"integer\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n##Response\n\n[See a list of specific response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/projects?offset=0&limit=25\\\",\\n  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/test\\\",\\n      \\\"id\\\": \\\"RFranklin/test\\\",\\n      \\\"name\\\": \\\"test\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/sandbox\\\",\\n      \\\"id\\\": \\\"RFranklin/sandbox\\\",\\n      \\\"name\\\": \\\"sandbox\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/my-project\\\",\\n      \\\"id\\\": \\\"RFranklin/my-project\\\",\\n      \\\"name\\\": \\\"my project\\\"\\n    }\\n  ],\\n  \\\"links\\\": []\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"/projects","slug":"list-all-your-projects","type":"endpoint","title":"List all your projects"}

getList all your projects

/projects

This call returns a list of all projects you are a member of. Each project's `project_id` and URL on the Platform will be returned. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/projects", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/projects HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://f4c-api.sbgenomics.com/v2/projects\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n<span style=\"color:red\"><i>required</i></span>", "0-1": "Your Platform[authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`fields`", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response.", "1-0": "`offset`", "2-0": "`limit`", "1-2": "The zero-based starting index in the entire collection of the first item to return. The default value is 0. This is a pagination-specific attribute.", "2-2": "The maximum number of collection items to return for a single request. Minimum value is 1. The maximum value is 100 and the default value is 25. This is a pagination-specific attribute.", "1-1": "integer", "2-1": "integer" }, "cols": 3, "rows": 3 } [/block] ##Response [See a list of specific response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://f4c-api.sbgenomics.com/v2/projects?offset=0&limit=25\",\n \"items\": [\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/test\",\n \"id\": \"RFranklin/test\",\n \"name\": \"test\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/sandbox\",\n \"id\": \"RFranklin/sandbox\",\n \"name\": \"sandbox\"\n },\n {\n \"href\": \"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/my-project\",\n \"id\": \"RFranklin/my-project\",\n \"name\": \"my project\"\n }\n ],\n \"links\": []\n}", "language": "json" } ], "sidebar": true } [/block]