Seven Bridges knowledge centerDocumentation
API Reference

List projects owned by a particular user

get https://cavatica-api.sbgenomics.com/v2

/projects/{owner}

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

List the projects owned by and accessible to a particular user. Each project's ID and URL will be returned.

https://cavatica-api.sbgenomics.com/v2/projects/{owner}

Request

Example request

GET /v2/projects/RFranklin HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin"

Header Fields

NameDescription
X-SBG-Auth-Token
required		Your CAVATICA authentication token.

Path parameters

NameDescription
ownerThe owner whose projects you want to query.

Query parameters

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

Response

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

Example response body

{
  "href": "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin",
  "items": [
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/Quickstart",
      "id": "RFranklin/Quickstart",
      "name": "Quickstart",
    },
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-project",
      "id": "RFranklin/my-project",
      "name": "My project",
      "description": "testing testing.\n* one\n* two\n* three"
    }
  ]
}

Related API requests

Language