List members of a project

/projects/{project_owner}/{project}/members

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

This call returns a list of the members of the specified project. For each member, the response lists:

  • The member's username on CAVATICA
  • The member's permissions in the project specified

šŸ‘

Project member permissions

For information about the permissions project members may have, see the documentation on setting permissions.

https://api.sbgenomics.com/v2/projects/{owner}/{project}/members

Request

Example request

GET /v2/projects/rfranklin/my-project/members 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/my-project/members"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

Path parameters

Name

Description

project

The ID of the project you are querying.

owner

The owner of the project you are querying.

Query parameters

Name

Data type

Description

fields

string

Selector 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/my-project/members?offset=0&limit=25",
  "items": [
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-project/members/RFranklin",
      "username": "RFranklin",
      "permissions": {
        "write": true,
        "read": true,
        "copy": true,
        "execute": true,
        "admin": true
      }
    },
    {
      "href": "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-project/members/Crick",
      "username": "Crick",
      "permissions": {
        "write": false,
        "read": true,
        "copy": false,
        "execute": false,
        "admin": false
      }
    }
  ],
  "links": []
}

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