Lookup User
Look up a user by username, uid, or id — optionally with full profile data.
Resolve a haunt.gg user by their username, numeric uid, or internal id. By
default the response is a lean basic payload; opt into additional data (full
profile, badges, links, projects, and more) with per-section include flags so you
only ever transfer what you need.
GET
/api/lookup/userAuthorizations
X-API-KeyheaderstringrequiredAPI key from your dashboard with the
lookup:user permission (granted by staff). Treat it like a password.Query Parameters
typequerystringrequiredHow to interpret
value. One of username, uid, or id. Username matching is case-insensitive and falls back to aliases.valuequerystringrequiredThe lookup value: a username, a numeric uid, or an internal user id. 1–64 characters.
profilequerybooleanInclude the active profile (display name, description, theme, fonts, and resolved asset URLs). Pass the literal string
true. Defaults to false.badgesquerybooleanInclude the user's enabled badges. Pass
true. Defaults to false.widgetsquerybooleanInclude the active profile's widgets. Pass
true. Defaults to false.audiosquerybooleanInclude the active profile's audio tracks. Pass
true. Defaults to false.backgroundsquerybooleanInclude the active profile's backgrounds. Pass
true. Defaults to false.linksquerybooleanInclude the active profile's links. Pass
true. Defaults to false.projectsquerybooleanInclude the active profile's projects. Pass
true. Defaults to false.viewsquerybooleanInclude the profile view count. Pass
true. Defaults to false.aliasesquerybooleanInclude the user's aliases. Pass
true. Defaults to false.skillsquerybooleanInclude the active profile's skills. Pass
true. Defaults to false.Only the sections you opt into are queried and serialized, so the default
payload stays small. Include flags are read as exact strings — pass true
(e.g. profile=true); any other value is treated as false.
Example Request
Request
curl -X GET "https://haunt.gg/api/lookup/user?type=username&value=john&profile=true" \
-H "X-API-Key: YOUR_API_KEY"Response
Response
User found. Basic payload (no include flags).
{
"error": null,
"user": {
"id": "clz9k2x0a0000s601f8h3d7q2",
"uid": 1337,
"username": "john",
"name": "John",
"avatarUrl": "https://assets.haunt.gg/avatars/john.png",
"discordId": "1363890885443452989",
"premium": true,
"verified": false,
"imagehost": false,
"createdAt": "2026-01-15T10:30:00.000Z"
}
}