Users

Get a user by identity provider external ID

GET

https://discourse.example.com/u/by-external/{provider}/{external_id}.json

curl -X GET 'https://discourse.example.com/u/by-external/string/string.json' \
  -H 'Api-Key: string' \
  -H 'Api-Username: string'

const response = await fetch('https://discourse.example.com/u/by-external/string/string.json', {
  method: 'GET',
  headers: {
    'Api-Key': 'string',
    'Api-Username': 'string',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://discourse.example.com/u/by-external/string/string.json',
    headers={
        'Api-Key': 'string',
        'Api-Username': 'string',
    },
)
print(response.text)

200

{
  "user_badges": [],
  "user": {
    "id": 0,
    "username": "string",
    "name": "string",
    "avatar_template": "string",
    "last_posted_at": "string",
    "last_seen_at": "string",
    "created_at": "string",
    "ignored": true,
    "muted": true,
    "can_ignore_user": true,
    "can_ignore_users": true,
    "can_mute_user": true,
    "can_mute_users": true,
    "can_send_private_messages": true,
    "can_send_private_message_to_user": true,
    "trust_level": 0,
    "moderator": true,
    "admin": true,
    "title": "string",
    "badge_count": 0,
    "second_factor_backup_enabled": true,
    "user_fields": {
      "1": "string",
      "2": "string"
    },
    "custom_fields": {
      "first_name": "string"
    },
    "time_read": 0,
    "recent_time_read": 0,
    "primary_group_id": 0,
    "primary_group_name": "string",
    "flair_group_id": 0,
    "flair_name": "string",
    "flair_url": "string",
    "flair_bg_color": "string",
    "flair_color": "string",
    "featured_topic": {
      "id": 0,
      "title": "string",
      "fancy_title": "string",
      "slug": "string",
      "posts_count": 0
    },
    "staged": true,
    "can_edit": true,
    "can_edit_avatar": true,
    "can_upload_avatar": true,
    "can_edit_username": true,
    "can_edit_email": true,
    "can_edit_name": true,
    "uploaded_avatar_id": 0,
    "has_title_badges": true,
    "pending_count": 0,
    "pending_posts_count": 0,
    "profile_view_count": 0,
    "second_factor_enabled": true,
    "can_upload_profile_header": true,
    "can_upload_user_card_background": true,
    "post_count": 0,
    "topic_count": 0,
    "can_be_deleted": true,
    "can_delete_all_posts": true,
    "locale": "string",
    "muted_category_ids": [],
    "regular_category_ids": [],
    "watched_tags": [],
    "watching_first_post_tags": [],
    "tracked_tags": [],
    "muted_tags": [],
    "tracked_category_ids": [],
    "watched_category_ids": [],
    "watched_first_post_category_ids": [],
    "system_avatar_upload_id": "string",
    "system_avatar_template": "string",
    "associated_account_avatars": [
      {
        "id": 0,
        "name": "string",
        "upload_id": 0,
        "avatar_template": "string"
      }
    ],
    "selected_user_associated_account_id": 0,
    "muted_usernames": [],
    "ignored_usernames": [],
    "allowed_pm_usernames": [],
    "mailing_list_posts_per_day": 0,
    "can_change_bio": true,
    "can_change_location": true,
    "can_change_website": true,
    "can_change_tracking_preferences": true,
    "user_api_keys": "string",
    "user_passkeys": [],
    "sidebar_tags": [],
    "sidebar_category_ids": [],
    "display_sidebar_tags": true,
    "can_pick_theme_with_custom_homepage": true,
    "user_auth_tokens": [
      {
        "id": 0,
        "client_ip": "string",
        "location": "string",
        "browser": "string",
        "device": "string",
        "os": "string",
        "icon": "string",
        "created_at": "string",
        "seen_at": "string",
        "is_active": true
      }
    ],
    "user_notification_schedule": {
      "enabled": true,
      "day_0_start_time": 0,
      "day_0_end_time": 0,
      "day_1_start_time": 0,
      "day_1_end_time": 0,
      "day_2_start_time": 0,
      "day_2_end_time": 0,
      "day_3_start_time": 0,
      "day_3_end_time": 0,
      "day_4_start_time": 0,
      "day_4_end_time": 0,
      "day_5_start_time": 0,
      "day_5_end_time": 0,
      "day_6_start_time": 0,
      "day_6_end_time": 0
    },
    "use_logo_small_as_avatar": true,
    "featured_user_badge_ids": [],
    "invited_by": "string",
    "groups": [
      {
        "id": 0,
        "automatic": true,
        "name": "string",
        "display_name": "string",
        "user_count": 0,
        "mentionable_level": 0,
        "messageable_level": 0,
        "visibility_level": 0,
        "primary_group": true,
        "title": "string",
        "grant_trust_level": "string",
        "incoming_email": "string",
        "has_messages": true,
        "flair_url": "string",
        "flair_bg_color": "string",
        "flair_color": "string",
        "bio_raw": "string",
        "bio_cooked": "string",
        "bio_excerpt": "string",
        "public_admission": true,
        "public_exit": true,
        "allow_membership_requests": true,
        "full_name": "string",
        "default_notification_level": 0,
        "membership_request_template": "string",
        "members_visibility_level": 0,
        "can_see_members": true,
        "can_admin_group": true,
        "publish_read_state": true
      }
    ],
    "group_users": [
      {
        "group_id": 0,
        "user_id": 0,
        "notification_level": 0,
        "owner": true
      }
    ],
    "user_option": {
      "user_id": 0,
      "mailing_list_mode": true,
      "mailing_list_mode_frequency": 0,
      "email_digests": true,
      "email_level": 0,
      "email_messages_level": 0,
      "external_links_in_new_tab": true,
      "bookmark_auto_delete_preference": 0,
      "color_scheme_id": "string",
      "dark_scheme_id": "string",
      "dynamic_favicon": true,
      "enable_quoting": true,
      "enable_smart_lists": true,
      "enable_markdown_monospace_font": true,
      "digest_after_minutes": 0,
      "automatically_unpin_topics": true,
      "auto_track_topics_after_msecs": 0,
      "notification_level_when_replying": 0,
      "new_topic_duration_minutes": 0,
      "email_previous_replies": 0,
      "email_in_reply_to": true,
      "like_notification_frequency": 0,
      "notify_on_linked_posts": true,
      "push_notification_level": "string",
      "enable_upcoming_change_available_notifications": true,
      "include_tl0_in_digests": true,
      "theme_ids": [],
      "theme_key_seq": 0,
      "allow_private_messages": true,
      "enable_allowed_pm_users": true,
      "homepage_id": "string",
      "hide_profile_and_presence": true,
      "hide_profile": true,
      "hide_presence": true,
      "text_size": "string",
      "text_size_seq": 0,
      "title_count_mode": "string",
      "timezone": "string",
      "skip_new_user_tips": true,
      "default_calendar": "string",
      "oldest_search_log_date": "string",
      "sidebar_link_to_filtered_list": true,
      "sidebar_show_count_of_new_items": true,
      "watched_precedence_over_muted": true,
      "seen_popups": [],
      "composition_mode": 0,
      "interface_color_mode": 0,
      "automatically_translate": true,
      "understood_languages": [
        "string"
      ],
      "hidden_composer_toolbar_buttons": [
        "string"
      ],
      "show_original_content": true,
      "send_shortcut": "string"
    }
  }
}

Parameters

providerstringrequiredpath

Authentication provider name. Can be found in the provider callback URL: /auth/{provider}/callback

external_idstringrequiredpath

Response

200OKany

user response

Response fields application/json

user_badgesArray<any>required

userobjectrequired

Show child attributes

idintegerrequired

usernamestringrequired

namestringrequired

avatar_templatestringrequired

last_posted_atstring | nullrequired

last_seen_atstring | nullrequired

created_atstringrequired

ignoredbooleanrequired

mutedbooleanrequired

can_ignore_userbooleanrequired

can_ignore_usersboolean

can_mute_userbooleanrequired

can_mute_usersboolean

can_send_private_messagesbooleanrequired

can_send_private_message_to_userbooleanrequired

trust_levelintegerrequired

moderatorbooleanrequired

adminbooleanrequired

titlestring | nullrequired

badge_countintegerrequired

second_factor_backup_enabledboolean

user_fieldsobject

Show child attributes

1string | nullrequired

2string | nullrequired

custom_fieldsobjectrequired

Show child attributes

first_namestring | null

time_readintegerrequired

recent_time_readintegerrequired

primary_group_idinteger | nullrequired

primary_group_namestring | nullrequired

flair_group_idinteger | nullrequired

flair_namestring | nullrequired

flair_urlstring | nullrequired

flair_bg_colorstring | nullrequired

flair_colorstring | nullrequired

featured_topicobjectrequired

Show child attributes

idintegerrequired

titlestringrequired

fancy_titlestringrequired

slugstringrequired

posts_countintegerrequired

stagedbooleanrequired

can_editbooleanrequired

can_edit_avatarbooleanrequired

can_upload_avatarbooleanrequired

can_edit_usernamebooleanrequired

can_edit_emailbooleanrequired

can_edit_namebooleanrequired

uploaded_avatar_idinteger | nullrequired

has_title_badgesbooleanrequired

pending_countintegerrequired

pending_posts_countinteger

profile_view_countintegerrequired

second_factor_enabledbooleanrequired

can_upload_profile_headerbooleanrequired

can_upload_user_card_backgroundbooleanrequired

post_countintegerrequired

topic_countintegerrequired

can_be_deletedbooleanrequired

can_delete_all_postsbooleanrequired

localestring | nullrequired

muted_category_idsArray<any>required

regular_category_idsArray<any>required

watched_tagsArray<any>required

watching_first_post_tagsArray<any>required

tracked_tagsArray<any>required

muted_tagsArray<any>required

tracked_category_idsArray<any>required

watched_category_idsArray<any>required

watched_first_post_category_idsArray<any>required

system_avatar_upload_idstring | nullrequired

system_avatar_templatestringrequired

associated_account_avatarsArray<object>required

Show child attributes

idintegerrequired

namestringrequired

upload_idintegerrequired

avatar_templatestringrequired

selected_user_associated_account_idinteger | nullrequired

muted_usernamesArray<any>required

ignored_usernamesArray<any>required

allowed_pm_usernamesArray<any>required

mailing_list_posts_per_dayintegerrequired

can_change_biobooleanrequired

can_change_locationbooleanrequired

can_change_websitebooleanrequired

can_change_tracking_preferencesbooleanrequired

user_api_keysstring | nullrequired

user_passkeysarray

sidebar_tagsarray

sidebar_category_idsarray

display_sidebar_tagsboolean

can_pick_theme_with_custom_homepageboolean

user_auth_tokensArray<object>required

Show child attributes

idintegerrequired

client_ipstringrequired

locationstringrequired

browserstringrequired

devicestringrequired

osstringrequired

iconstringrequired

created_atstringrequired

seen_atstringrequired

is_activebooleanrequired

user_notification_scheduleobjectrequired

Show child attributes

enabledbooleanrequired

day_0_start_timeintegerrequired

day_0_end_timeintegerrequired

day_1_start_timeintegerrequired

day_1_end_timeintegerrequired

day_2_start_timeintegerrequired

day_2_end_timeintegerrequired

day_3_start_timeintegerrequired

day_3_end_timeintegerrequired

day_4_start_timeintegerrequired

day_4_end_timeintegerrequired

day_5_start_timeintegerrequired

day_5_end_timeintegerrequired

day_6_start_timeintegerrequired

day_6_end_timeintegerrequired

use_logo_small_as_avatarbooleanrequired

featured_user_badge_idsArray<any>required

invited_bystring | nullrequired

groupsArray<object>required

Show child attributes

idintegerrequired

automaticbooleanrequired

namestringrequired

display_namestringrequired

user_countintegerrequired

mentionable_levelintegerrequired

messageable_levelintegerrequired

visibility_levelintegerrequired

primary_groupbooleanrequired

titlestring | nullrequired

grant_trust_levelstring | nullrequired

incoming_emailstring | nullrequired

has_messagesbooleanrequired

flair_urlstring | nullrequired

flair_bg_colorstring | nullrequired

flair_colorstring | nullrequired

bio_rawstring | nullrequired

bio_cookedstring | nullrequired

bio_excerptstring | nullrequired

public_admissionbooleanrequired

public_exitbooleanrequired

allow_membership_requestsbooleanrequired

full_namestring | nullrequired

default_notification_levelintegerrequired

membership_request_templatestring | nullrequired

members_visibility_levelintegerrequired

can_see_membersbooleanrequired

can_admin_groupbooleanrequired

publish_read_statebooleanrequired

group_usersArray<object>required

Show child attributes

group_idintegerrequired

user_idintegerrequired

notification_levelintegerrequired

ownerboolean

user_optionobjectrequired

Show child attributes

user_idintegerrequired

mailing_list_modebooleanrequired

mailing_list_mode_frequencyintegerrequired

email_digestsbooleanrequired

email_levelintegerrequired

email_messages_levelintegerrequired

external_links_in_new_tabbooleanrequired

bookmark_auto_delete_preferenceinteger

color_scheme_idstring | nullrequired

dark_scheme_idstring | nullrequired

dynamic_faviconbooleanrequired

enable_quotingbooleanrequired

enable_smart_listsbooleanrequired

enable_markdown_monospace_fontbooleanrequired

digest_after_minutesintegerrequired

automatically_unpin_topicsbooleanrequired

auto_track_topics_after_msecsintegerrequired

notification_level_when_replyingintegerrequired

new_topic_duration_minutesintegerrequired

email_previous_repliesintegerrequired

email_in_reply_tobooleanrequired

like_notification_frequencyintegerrequired

notify_on_linked_postsbooleanrequired

push_notification_levelstringrequired

enable_upcoming_change_available_notificationsbooleanrequired

include_tl0_in_digestsbooleanrequired

theme_idsArray<any>required

theme_key_seqintegerrequired

allow_private_messagesbooleanrequired

enable_allowed_pm_usersbooleanrequired

homepage_idstring | nullrequired

hide_profile_and_presencebooleanrequired

hide_profilebooleanrequired

hide_presencebooleanrequired

text_sizestringrequired

text_size_seqintegerrequired

title_count_modestringrequired

timezonestring | nullrequired

skip_new_user_tipsbooleanrequired

default_calendarstring

oldest_search_log_datestring | null

sidebar_link_to_filtered_listboolean

sidebar_show_count_of_new_itemsboolean

watched_precedence_over_mutedboolean

seen_popupsarray | null

composition_modeinteger

interface_color_modeintegerrequired

automatically_translatebooleanrequired

understood_languagesArray<string>required

hidden_composer_toolbar_buttonsArray<string>required

show_original_contentbooleanrequired

send_shortcutstringrequired

Docs by Sourcey