Sign in

v51

latestOpenAPI 3.0.1Apache License Version 2.0raw.githubusercontent.com2026-08-01304136381.9 KB
users

Get a user by username.

get/users/username/{username}

Path parameters

usernamestring required

Query parameters

includestring

Comma-delimited list of fields to include: userProfiles, ...

Response

A user with the specified username

avatarUrlstring
curatorboolean

Indicates whether this user is a curator. The value is always false unless requested for oneself or by an admin

idinteger
isAdminboolean

Indicates whether the user is an admin. The value is always false unless requested for oneself or by an admin

metricsRobotboolean
metricsRobotPartner'GALAXY' | 'TERRA' | 'DNA_STACK' | 'DNA_NEXUS' | 'CGC' | 'NHLBI_BIODATA_CATALYST' | 'ANVIL' | 'CAVATICA' | 'NEXTFLOW_TOWER' | 'ELWAZI' | 'AGC' | 'TOIL' | 'OTHER' | 'ALL'

Indicates whether this user is a robot that submits metrics

namestring
orcidstring
platformPartner'GALAXY' | 'TERRA' | 'DNA_STACK' | 'DNA_NEXUS' | 'CGC' | 'NHLBI_BIODATA_CATALYST' | 'ANVIL' | 'CAVATICA' | 'NEXTFLOW_TOWER' | 'ELWAZI' | 'AGC' | 'TOIL' | 'OTHER' | 'ALL'

Indicates whether this account corresponds to a platform partner

privacyPolicyVersion'NONE' | 'PRIVACY_POLICY_VERSION_2_5'
privacyPolicyVersionAcceptanceDateinteger
setupCompleteboolean
tosacceptanceDateinteger
tosversion'NONE' | 'TOS_VERSION_1' | 'TOS_VERSION_2'
tosversionAcceptanceDateinteger
userProfilesobject
usernamestring
usernameChangeRequiredboolean

Indicates whether the user is required to change their username before being allowed to do various operations on Dockstore.