Skip to navigation

Get User Profile

View as Markdown

The POST /api/user/userdetailsbyuserid endpoint is used to retrieve user details based on the user ID.

Request

  • Method: POST

  • Base URL: {{baseUrl}}

  • Path: /api/user/userdetailsbyuserid

  • Headers:

    • Content-Type: application/x-www-form-urlencoded
  • Body:

    • userid (text): The user ID for which details are to be retrieved.

    • auth (text): The authentication token for the request.

Response

The response will be in JSON format and will include the following fields:

  • success (boolean): Indicates if the request was successful.

  • message (string): Additional information or error message.

  • details (object): Object containing user details with the following fields:

    • idst (string): The user’s ID.

    • userid (string): The user’s ID.

    • firstname (string): The user’s first name.

    • lastname (string): The user’s last name.

    • avatar (string): URL to the user’s avatar.

    • email (string): The user’s email address.

    • signature (string): The user’s signature.

    • valid (string): Indicates if the user is valid.

    • pwd_expire_at (string): Date when the user’s password expires.

    • register_date (string): Date of user registration.

    • last_enter (string): Date of user’s last entry.

    • custom_fields (array): Array of custom fields associated with the user.

Request

This endpoint expects an object.
authstringRequired
useridstringRequired

Response headers

Keep-AlivestringOptional
X-Powered-BystringOptional

Response

OK
detailsobject
messagestring
successboolean