View a user's details

Learn about the GetUserDetailsFromService endpoint in the ExternalUser collection.

This API lets you retrieve the details of an existing end user.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

API request

Sample

GET {{ServerURL}}/api/ExternalUser/GetUserDetailsFromService?serviceUserId=3242453453

Parameters

Parameter	Description
serviceName	Name of the user.
serviceUserId	Unique identifier of the user.
phoneNumber	Phone number of the user.

API response

Sample

{
    "result": {
        "foreign_ID": "21e7c4df-3c26-40a4-b931-c08be6def207",
        "service_Name": "John Doe",
        "language": "English",
        "last_active": "2024-11-23T15:24:54.465Z"
    },
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}

Attributes

Attribute	Description
id	Unique identifier for the user
userId	An identifying label for the user, for reference
foreign_ID	An alternate identifying label for the user, if available, for reference
service_Name	Name of the user
language	Language used by the user when interacting with the platform
last_session_id	Unique identifier of the user's last interaction session with the platform.
last_active	Exact time and date of the user's last interaction with the platform.