v14

OpenAPI 3.1.02026-08-03122113375.9 KB
search

Search users

Lookup one or more users by ID and/or username.

Use this for quick user hydration in:

  • conversation lists
  • activity feeds
  • review lists
  • any UI that only has IDs/usernames and needs profile summaries

Behavior:

  • Accepts a mix of ids and usernames.
  • Returns matched user records in one round-trip.

Good to know:

  • Responses are cached briefly for repeated lookup payloads.
post/search/users

Request body

idsstring[]

List of user IDs to lookup

usernamesstring[]

List of usernames to lookup

Response

List of users

idstring required

Unique identifier for the user

usernamestring required

Public username of the user

joinedstring date-time

ISO timestamp when the user account was created

avatarstring uri

URL to the user's avatar image

coverstring uri

URL to the user's cover image

profilestring

Information about the user

reviewsinteger required

Total number of reviews the user has received

ratingnumber required

Confidence-based rating between 0 and 5

scorenumber required

Average rating between 0 and 5

salesinteger required

Total number of sales the user has made

purchasesinteger required

Total number of purchases the user has made