get https://cgc-api.sbgenomics.com/v2
/projects/{owner}
List the projects owned by and accessible to a particular user. Each project's ID and URL will be returned.
https://cgc-api.sbgenomics.com/v2/projects/{owner}
Request
Example request
GET /v2/projects/RFranklin HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X GET "https://cgc-api.sbgenomics.com/v2/projects/RFranklin"
Header Fields
Name | Description |
---|---|
X-SBG-Auth-Token required | Your CGC authentication token. |
Path parameters
Name | Description |
---|---|
owner | The owner whose projects you want to query. |
Query parameters
Name | Data type | Description |
---|---|---|
fields | string | Selector specifying a subset of fields to include in the response. |
Response
See a list of CGC-specific response codes that may be contained in the body of the response.
Example response body
{
"href": "https://cgc-api.sbgenomics.com/v2/projects/RFranklin",
"items": [
{
"href": "https://cgc-api.sbgenomics.com/v2/projects/RFranklin/Quickstart",
"id": "RFranklin/Quickstart",
"name": "Quickstart",
},
{
"href": "https://cgc-api.sbgenomics.com/v2/projects/RFranklin/my-project",
"id": "RFranklin/my-project",
"name": "My project",
"description": "testing testing.\n* one\n* two\n* three"
}
]
}