List all your projects

/projects

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

This call returns a list of all projects you are a member of. Each project's project_id and URL on CAVATICA will be returned.

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

Request

Example request

GET /v2/projects 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"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

Query parameters

Name

Data type

Description

name

string

Filter projects by the project name. The search is partial and case-insensitive.

fields

string

Selector specifying a subset of fields to include in the response.

offset

integer

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.

limit

integer

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.

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?offset=0&limit=25",
  "items": [
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/test",
      "id": "RFranklin/test",
      "name": "test"
    },
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/sandbox",
      "id": "RFranklin/sandbox",
      "name": "sandbox"
    },
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-project",
      "id": "RFranklin/my-project",
      "name": "my project"
    }
  ],
  "links": []
}

Related API requests


Language
Click Try It! to start a request and see the response here!