Modbot Docs
APIAPI referenceVRChat users

Get VRChat profile

GET/api/vrchat-users/profile

The 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.

AuthorizationBearer <token>

An API key, made on Settings, API keys. Every key starts with mbk_.

In: header

Query Parameters

vrchatUserId*string

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"}

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.