Get VRChat profile
/api/vrchat-users/profileThe profile as of lastRefreshedAt, never fresher. stale says whether it is older than the sync's own threshold. eighteenPlus is Modbot's sticky flag: true once the person has ever been seen as 18+ verified, cleared only by a moderator -- it can disagree with ageVerificationStatusLastSeen, and that is the point. refresh.pending is true while a refresh is queued or in flight; poll this endpoint until lastRefreshedAt moves or refresh.pending clears.
Needs the ViewProfile permission.
An API key, made on Settings, API keys. Every key starts with mbk_.
In: header
Query Parameters
Also accepted as id.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/api/vrchat-users/profile?vrchatUserId=string"{ "userId": "string", "known": true, "displayName": null, "plainName": null, "bio": null, "status": null, "statusDescription": null, "pronouns": null, "avatarImageUrl": null, "avatarThumbnailUrl": null, "profilePictureUrl": null, "iconUrl": null, "bannerUrl": null, "representedGroup": null, "dateJoined": null, "tags": [ "string" ], "trustRank": null, "lastPlatform": null, "ageVerificationStatusLastSeen": null, "ageVerifiedLastSeen": null, "eighteenPlus": { "verified": true, "since": null, "source": null, "setByUserId": null, "setByUsername": null }, "firstSeenAt": null, "lastSeenAt": null, "lastRefreshedAt": null, "stale": true, "staleAfterSeconds": 0.1, "refreshError": null, "refreshErrorAt": null, "notFoundAt": null, "refresh": { "pending": true, "reason": null, "requestedAt": null, "inProgress": true, "blocked": null }, "now": "2019-08-24T14:15:22Z"}Get membership GET
Whether they are a member now, with which roles and since when; whether the ban list holds them; and how fresh both answers are. `known` is false when no sweep has ever listed them as a member. Needs the `ViewMembers` permission.
Get time in world GET
How long this person has been seen in world, where, and how often. Computed from the companion's presence reports, so it only covers time a moderator's client was in the same instance. Somebody who has never shared an instance with the client reads as nothing here, which is not the same as never having been in one — and the screen says so. Gated on ViewProfile rather than ViewAnalytics: this is one person's own record rather than an aggregate, and it sits beside the rest of their profile. Needs the `ViewProfile` permission.