API ReferenceUser Profiles

Get user profile

This API enables you to get an existing user profile.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

WSIDstringRequired
Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.
versionenumRequiredDefaults to live
Specify the version for which you would like to manage the user profile.
Allowed values:
distinct_idstringRequired
Enter the distinct ID that you currently use to identify the user.

Response

This endpoint returns an object.
channelobject
country_codestring
The country code of the user. This value is automatically determined based on the number provided in the SMS channel of the profile. For a list of possible values, please <a href="https://content.fyno.io/docs/files/country_code.json" target="_blank">click here</a>.
created_atstring
The timestamp when the profile was created in ISO Date Time Format.
distinct_idstring
The distinct ID used to identify the user.
id_listlist of any
Other profile IDs previously linked to this profile.
profile_idstring
Unique profile ID within Fyno.
statusenum

The status of the user. If 1, the user is active and should receive notifications. If 0, the user in inactive and should not receive notifications.

Allowed values:
timezonestring
The timezone of the user. For a list of possible values, please <a href="https://content.fyno.io/docs/files/timezones.json" target="_blank">click here</a>.
timezone_offsetstring
The timezone offset of the user. The value is automatically determined based on the timezone provided for the user in the profile.
updated_atstring
The timestamp when the profile was last updated in ISO Date Time Format.
versionenum
The version where the user profile is available.
Allowed values:
namestring or null
The full name of the user.

Errors