Get started
Users
Cards
Projects
Pages
Comments
Boards
Sprints
Spaces
Search
Get my account
Fetches detailed information about a user, including profile details, teams, locale, and other metadata. Indicates if the token used in the request is privileged or outdated. Privileged tokens are necessary for specific sensitive operations like email updates.
curl --request GET \
--url https://api.superthread.com/v1/users/{user_id}{
"user": {
"id": "u-dsu0j19",
"email": "[email protected]",
"email_confirmed": true,
"first_name": "John",
"last_name": "Smith",
"display_name": "pete",
"profile_image": "https://s3..../avatar.png",
"thumbnail_image": "https://s3..../avatar.png",
"color": "red",
"status": "active",
"teams": [
{
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"id": "t-iwquhs1",
"sub_domain": "apple",
"team_name": "Apple Backend",
"company_name": "Apple Inc",
"email_domain": "apple.com",
"creator_user_id": "u-dsu0j19",
"time_created": 1608742037016,
"time_updated": 1608742037016,
"trashed": {
"user_deleted": {
"user_id": "uDsu0j19",
"type": "user",
"source": {
"type": "oauth",
"client_id": "oczapier",
"import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"email_addr": "[email protected]",
"email_verified": false
}
},
"time_deleted": 1608742037016
},
"logo": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"subscription_plan_id": "free",
"features": [
{
"id": "<string>",
"enabled": true,
"time_enabled": 1608742037016,
"toggleable": true
}
],
"limits": [
{
"id": "<string>",
"limit_value": "2"
}
],
"team_description": "Technology company",
"role": "owner",
"status": "active",
"flags": [
"ai0"
]
}
],
"time_created": 1608742037016,
"time_updated": 1608742037016,
"current_project": "<string>",
"timezone_id": "America/Los_Angeles",
"autodetect_timezone_id": true,
"locale": "en",
"transcription_keywords": [
"<string>"
],
"job_description": "software engineer"
},
"token_outdated": true,
"token_privileged": true
}You can replaceuser_idwithmein order to return your own account details. (https://api.superthread.com/v1/users/me)
Path Parameters
User ID is an alphanumerical string that identifies a user.
Response
user response
Show child attributes
Show child attributes
"u-dsu0j19"
true
"John"
"Smith"
"pete"
"https://s3..../avatar.png"
"https://s3..../avatar.png"
red, darkred, green, darkgreen, blue, darkblue "red"
active, suspended Show child attributes
Show child attributes
"t-iwquhs1"
"apple"
"Apple Backend"
"Apple Inc"
"apple.com"
"u-dsu0j19"
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
Show child attributes
Show child attributes
describes a user or robot that created or updated a resource
Show child attributes
Show child attributes
"uDsu0j19"
user, robot, system "user"
describes the source of an actor
Show child attributes
Show child attributes
oauth, import, email, agent "oauth"
client ID if the resource was created via oauth2 app
"oczapier"
import ID if the resource was created by an import
"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"
agent ID if the resource was created by an agent
"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"
email address if the resource was created via an email
whether the email sender was verified
false
unix timestamp in seconds
1608742037016
Show child attributes
Show child attributes
image, icon, emoji Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name
"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="
Unique identifier for the image (optional).
"LEHV6nWB2yk8pyoJadR*.7kCMdnj"
"black"
Emoji string ID
"thumbsup"
"free"
"Technology company"
owner, admin, member, guest, guestReader active, invited, inactive, imported list of feature flags enabled for the user in the team
unix timestamp in seconds
1608742037016
unix timestamp in seconds
1608742037016
user's timezone
"America/Los_Angeles"
whether the user's timezone is automatically set by the superthread app
true
user's preferred locale
"en"
"software engineer"
was the token used for this request privileged? privileged tokens are required for certain operations (update email) and are obtained from a fresh login (not a refresh).
curl --request GET \
--url https://api.superthread.com/v1/users/{user_id}{
"user": {
"id": "u-dsu0j19",
"email": "[email protected]",
"email_confirmed": true,
"first_name": "John",
"last_name": "Smith",
"display_name": "pete",
"profile_image": "https://s3..../avatar.png",
"thumbnail_image": "https://s3..../avatar.png",
"color": "red",
"status": "active",
"teams": [
{
"archived": {
"user_id": "uDsu0j19",
"time_archived": 1608742037016
},
"id": "t-iwquhs1",
"sub_domain": "apple",
"team_name": "Apple Backend",
"company_name": "Apple Inc",
"email_domain": "apple.com",
"creator_user_id": "u-dsu0j19",
"time_created": 1608742037016,
"time_updated": 1608742037016,
"trashed": {
"user_deleted": {
"user_id": "uDsu0j19",
"type": "user",
"source": {
"type": "oauth",
"client_id": "oczapier",
"import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
"email_addr": "[email protected]",
"email_verified": false
}
},
"time_deleted": 1608742037016
},
"logo": {
"type": "image",
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"subscription_plan_id": "free",
"features": [
{
"id": "<string>",
"enabled": true,
"time_enabled": 1608742037016,
"toggleable": true
}
],
"limits": [
{
"id": "<string>",
"limit_value": "2"
}
],
"team_description": "Technology company",
"role": "owner",
"status": "active",
"flags": [
"ai0"
]
}
],
"time_created": 1608742037016,
"time_updated": 1608742037016,
"current_project": "<string>",
"timezone_id": "America/Los_Angeles",
"autodetect_timezone_id": true,
"locale": "en",
"transcription_keywords": [
"<string>"
],
"job_description": "software engineer"
},
"token_outdated": true,
"token_privileged": true
}