Manage User Profiles

Get user profile

This API enables you to get an existing user profile.

get/{WSID}/{version}/profiles/{distinct_id}

Path parameters

WSIDstring required

Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.

version'live' | 'test' required

Specify the version for which you would like to manage the user profile.

distinct_idstring required

Enter the distinct ID that you currently use to identify the user.

Response

Profile fetched successfully

country_codestring required

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 required

The timestamp when the profile was created in ISO Date Time Format.

distinct_idstring required

The distinct ID used to identify the user.

id_liststring[] required

Other profile IDs previously linked to this profile.

namestring

The full name of the user.

profile_idstring required

Unique profile ID within Fyno.

status1 | 0 required

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.

timezonestring required

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 required

The timezone offset of the user. The value is automatically determined based on the timezone provided for the user in the profile.

updated_atstring required

The timestamp when the profile was last updated in ISO Date Time Format.

version'live' | 'test' required

The version where the user profile is available.

Example response

{
  "channel": {
    "discord": "101XXXXXXXXXX7XXXXX",
    "email": "abcde@fghi.com",
    "inapp": [
      {
        "integration_id": "IXXXXXXX",
        "status": 1,
        "token": "XXXXXXXX"
      }
    ],
    "push": [
      {
        "integration_id": "IXXXXXXX",
        "status": 1,
        "token": "ExponentPushToken[XXXXX]"
      }
    ],
    "slack": "CXXXXXXXXXX",
    "sms": "+91 9879X XXXXX",
    "teams": "General",
    "voice": "+91 9879X XXXXX",
    "whatsapp": "+91 9879X XXXXX"
  },
  "country_code": "IN",
  "created_at": "2023-04-21T06:34:01.386Z",
  "distinct_id": "XXXXXXXX",
  "id_list": [
    "6442XXXXXXXXXXXXXXXXc684"
  ],
  "name": "John Doe",
  "profile_id": "6442XXXXXXXXXXXXXXXXc685",
  "status": 1,
  "timezone": "Asia/Kolkata",
  "timezone_offset": "+05:30",
  "updated_at": "2023-04-21T08:42:30.235Z",
  "version": "test"
}

Changes

Changed in 1 of the 35 revisions of this API.16

Feb 17, 2025ee2cf82f4e6a16See the full diff
- ○
  the response property _message became required for the status 400
  response-property-became-required
- ○
  the response property _message became required for the status 401
  response-property-became-required
- ○
  the response property channel became required for the status 200
  response-property-became-required
- ○
  the response property channel/inapp/items/token became required for the status 200
  response-property-became-required
- ○
  the response property country_code became required for the status 200
  response-property-became-required
- ○
  the response property created_at became required for the status 200
  response-property-became-required
- ○
  the response property distinct_id became required for the status 200
  response-property-became-required
- ○
  the response property id_list became required for the status 200
  response-property-became-required
- ○
  the response property profile_id became required for the status 200
  response-property-became-required
- ○
  the response property status became required for the status 200
  response-property-became-required
- ○
  the response property status became required for the status 400
  response-property-became-required
- ○
  the response property status became required for the status 401
  response-property-became-required
- ○
  the response property timezone became required for the status 200
  response-property-became-required
- ○
  the response property timezone_offset became required for the status 200
  response-property-became-required
- ○
  the response property updated_at became required for the status 200
  response-property-became-required
- ○
  the response property version became required for the status 200
  response-property-became-required

Full history