Get details of a project


For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

This call returns the details of a specified project.{project_owner}/{project}


Example request


Referring to your project

Note that project_owner is always case-sensitive, and that project is not the project's name but its short name. For full details of identifying objects using the API, please see the API overview.

GET /v2/projects/rfranklin/my-project HTTP/1.1
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl  -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X GET ""

Header Fields

Your CAVATICA authentication token.

Path parameters

projectThe short name of the project you are querying.
project_ownerThe owner of the project you are querying.

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.


See a list of CAVATICA-specific response codes that may be contained in the body of the response.

Example response body

  "href": "",
  "id": "rfranklin/rfranklin-s-demo-project",
  "name": "rfranklin's Demo Project",
  "type": "v2",
  "description": "This project contains data, completed analyses, and results.\n\Contains WGS, WES, and two different RNA-Seq read alignments - STAR and TopHat, fusion transcript detection analysis using ChimeraScan, FASTQ quality control and more.\n\n Open it up and  take a look.",
  "tags": [],
  "settings": {
    "locked": false,
    "use_interruptible_instances": false,
    "use_memoization": true,
    "allow_network_access": true,
    "intermediate_files": {
  "permissions": {
    "write": true,
    "read": true,
    "copy": true,
    "execute": true,
    "admin": true
  "billing_group": "ec1dc1e3-12a3-4b56-789c-e3f2dca0c6f7"


Interpreting the response body

The object type in the response should be ignored: all projects have type v2.