List user resources

/users/{username}

This call returns information about the specified user. Note that currently you can view only your own user information, and so this call is equivalent to the call to Get my information.

https://cgc-api.sbgenomics.com/v2/users/{username}

This call will only return a successful response if {username} is replaced with your own username.

👍

Case sensitivity

Don't forget to capitalize your username in the same way as you set it when you registered on the CGC.

Request

Example request

GET /v2/users/RFranklin HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://cgc-api.sbgenomics.com/v2/users/RFranklin"

Header Fields

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

Path parameters

NameDescription
usernameUsername of the user you're 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/users/RFranklin",
  "username": "RFranklin",
  "email": "[email protected]",
  "first_name": "Rosalind",
  "last_name": "Franklin",
  "affiliation": "Seven Bridges",
  "phone": "",
  "address": "",
  "city": "London",
  "state": "",
  "country": "United Kingdom",
  "zip_code": ""
}
Language