GET user/{userId}

Related

Get the complete info for a user.

Note: this is not intended for public access; see the user info method for general use.

Example

GET /api/v1/user/66a5db1f-2785-498d-9068-e24ddbba03f2 HTTP/1.1
Accept: application/json
Authorization: Bearer ...
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
ETag: ...

{
  "id": "66a5db1f-2785-498d-9068-e24ddbba03f2",
  "username": "tcoles+test01",
  "email": "tcoles+test01@elinemedia.com",
  "avatar": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
  "emblem": null,
  "fullProfile": {
    "profile": "This is my profile!",
  },
  "publicProfile": {
    "profile": "This is my profile!",
  }
}

Security

Authentication is required for this method, and access is restricted to the user themself.

URL Parameters

NameDescriptionValue
userIdthe ID of the user as a GUID with dashesstring

Query Parameters

NONE

Request Body

NONE

Response

Successful responses are code 200 with data in the response body. Error responses are standard.

Response Body

NameDescriptionValue
idthe ID of the user as a GUID with dashesstring
usernamethe user's username, which is uniquestring
emailthe user's email addressstring
avatara media path to the user's avatar image file; will be null if no avatar has been setstring or null
emblemthe GUID of an emblem to display with the user's avatar, or null if none is selectedstring or null
fullProfilethe user's full profileobject; see Profile
publicProfilethe user's public profile; fields are a subset of full profile based on each field's public visibility settingobject; see Profile

Profile

NameDescriptionValue
profilea text description of this user, if public optionalstring