HEhexclave
Teams

Get a team member profile

Changed on

Get a team member profile. you can always get your own profile by setting me as the user_id in the path parameters on the client. If you want to get someone else's profile in a team, you need to have the $read_members permission in that team.

get/team-member-profiles/{team_id}/{user_id}

Request

  • Base URL
    https://api.hexclave.com/api/v1
  • URL
    https://api.hexclave.com/api/v1/team-member-profiles/{team_id}/{user_id}
  • Auth
    none declared

Path parameters

team_idstring required
user_idstring required

The ID of the user, or the special value me for the currently authenticated user

Example:3241a285-8329-4d69-8f3d-316e08cf140c

Response

Successful response

team_idstring required

The unique identifier of the team

user_idstring required

The unique identifier of the user

display_name'null' nullable

Human-readable team member display name. This is not a unique identifier. Note that this is separate from the display_name of the user.

profile_image_url'null' nullable

URL of the profile image for team member. Can be a Base64 encoded image. Must be smaller than 100KB. Please compress and crop to a square before passing in.

Example response

{
  "team_id": "ad962777-8244-496a-b6a2-e0c6a449c79e",
  "user_id": "3241a285-8329-4d69-8f3d-316e08cf140c",
  "display_name": "John Doe",
  "profile_image_url": "https://example.com/image.jpg"
}

Changes

  • fc669d833a13Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

      added the new undefined enum value to the response property for the response status

    • warning

      added the new undefined enum value to the response property for the response status