FOforem
users

Search for users

Changed on

Search for a user by email address.

Permissions & Context:

  • Requires administrative privileges (api-key of an administrator).
  • Used to verify account existence or map email addresses to platform usernames.
get/api/users/search

Request

  • Base URL
    https://dev.to
  • Auth
    • API key in header api-key
    • or HTTP bearer

Query parameters

emailstring required

The exact email address of the user to search for.

Response

successful

type_ofstring
idinteger
usernamestring
namestring
summarystring nullable
twitter_usernamestring
github_usernamestring
emailstring nullable

Email (requires authentication and if user allows displaying email on their profile) or nil

website_urlstring nullable
locationstring nullable
joined_atstring
profile_imagestring
badge_idsinteger[]

ids of the badges awarded to the user

Changes