Retrieve User Profile
GET https://api.helpshift.com/v1/{{domain}}/user-profiles?app_id={{app_publish_id}}
Retrieve End-User Profile based on user identifiers. This uses the same logic to identify user profiles as used in the SDK and WebChat - At least one of the following must be provided: user id, email, phone number, channel & channel identifier. A profile-id can also be provided to retrieve the end-user profile directly.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
app_id | string | App Publish ID. Required. The user will be specific to the given app. | |
| To retrieve end-users for web/email users, use the value "1" for app publish ID. | |||
user_id | string | User UID. | |
email | string | User Email | |
phone_number | string | User Phone Number | |
channel | string | Third Party Channel. If channel is present, channel_id must also be present. | |
| Allowed Values - abc, fbm, sms | |||
channel_id | number | Channel specific identifier. If channel_id is present, channel must also be present. | |
profile_id | string | User profile Internal ID |
RESPONSES
status: OK
{"created_at":"2020-11-30T06:26:38.091Z","email":"visitor@example.net","name":"visitor","updated_at":"2020-11-30T06:26:38.091Z","profile_id":"moana_profile_ae968698504ea6f3f9370e9c8c3a7344276929bd","timezone":"Etc/UTC"}