GuidesAPIDatasets HubRelease Notes
API Reference
CGC

List members of a project

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

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

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

  • The member's username on the CGC
  • 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://cgc-api.sbgenomics.com/v2/projects/{owner}/{id}/members

Request

Example request

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

Header Fields

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

Path parameters

NameDescription
projectThe ID 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.

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/my-project/members?offset=0&limit=25",
  "items": [
    {
      "href": "https://cgc-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://cgc-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