Skip to main content
This tool is part of the User Tools category.

​
Parameters

NameTypeRequiredDescription
user_idstringYesThe ID of the user to retrieve

​
Example Request

{
  "user_id": "user_12345"
}

​
Example Response

{
  "id": "user_12345",
  "email": "user@example.com",
  "first_name": "John",
  "last_name": "Doe",
  "display_name": "John Doe",
  "preferences": {
    "notifications": {
      "email": true,
      "push": false
    },
    "theme": "light"
  },
  "metadata": {
    "company": "Example Corp",
    "role": "Content Creator"
  },
  "created_at": "2023-01-10T15:30:00.000Z",
  "updated_at": "2023-05-15T09:45:00.000Z"
}

​
Usage Notes

  • If the specified user does not exist, a 404 Not Found error will be returned.
  • User IDs are unique within your tenant application.
  • The response includes basic user information such as email, name, and preferences.
  • Additional user metadata may be included depending on your application’s configuration.
  • Use this method when you need detailed information about a specific user.
  • For bulk operations, consider using Get Users By Tenant App instead.
⌘I