> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://fyno.io/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://fyno.io/docs/_mcp/server.

# Get user preference

GET https://api.fyno.io/v1/{WSID}/{version}/subscriptions/preference

This API enables you to get all the subscriptions topics (with sections) defined in your workspace along with the opted-in/opted-out preference of a particular user.

Reference: https://fyno.io/docs/api-reference/get-user-preference

## Authentication

- `Authorization` header (bearer token, required) — Enter your API Key. If you don't have it already, you can create one from the API Keys page within your Fyno account

## Request

### Path parameters

- `WSID` (string, required) — Enter your workspace ID. You can obtain this value from the API Keys page within your Fyno account.
- `version` (string, required) — Specify the version for which you would like to manage the user profile.

### Query parameters

- `distinct_id` (string, required) — Enter the distinct ID that you currently use to identify the user.
- `event_list` (boolean, optional, default: false) — Set this value to 'true' to receive list of notification events attached to each subscription topic.

## Response

### 200

Preference fetched successfully

- `meta` (WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaMeta, required)
- `result` (WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaResult, required)

## Errors

### 400 Bad Request Error

Distinct ID is not provided

- `_message` (string, required)
- `status` (string, required)

### 401 Unauthorized Error

API Key or Workspace ID is invalid. User is unauthorised.

- `_message` (string, required)
- `status` (string, required)

## Types

### WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaMeta

- `all` (WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaMetaAll, required)

### WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaResult

- `Section1` (list of WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaResultSection1Items, required)

### WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaMetaAll

- `preference` (preference_channels_opted_out, required)
- `updated_at` (updated_at, required)

### WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaResultSection1Items

- `channel_config` (WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaResultSection1ItemsChannelConfig, required)
- `description` (string, required)
- `is_global_opted_out` (WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaResultSection1ItemsIsGlobalOptedOut, required)
- `name` (string, required)
- `notification_events` (list of WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaResultSection1ItemsNotificationEventsItems, required)
- `preference` (preference_channels, required)
- `subscription_id` (string, required)
- `updated_at` (updated_at, required)

### preference_channels_opted_out

- `discord` (enum, optional)
  - Allowed values: `opted-out`
- `email` (enum, optional)
  - Allowed values: `opted-out`
- `inapp` (enum, optional)
  - Allowed values: `opted-out`
- `push` (enum, optional)
  - Allowed values: `opted-out`
- `slack` (enum, optional)
  - Allowed values: `opted-out`
- `sms` (enum, optional)
  - Allowed values: `opted-out`
- `teams` (enum, optional)
  - Allowed values: `opted-out`
- `voice` (enum, optional)
  - Allowed values: `opted-out`
- `whatsapp` (enum, optional)
  - Allowed values: `opted-out`

### updated_at

- `discord` (string, optional)
- `email` (string, optional)
- `inapp` (string, optional)
- `push` (string, optional)
- `slack` (string, optional)
- `sms` (string, optional)
- `teams` (string, optional)
- `voice` (string, optional)
- `webpush` (string, optional)
- `whatsapp` (string, optional)

### WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaResultSection1ItemsChannelConfig

- `discord` (enum, optional, default: on)
  - Allowed values: `on`, `off`, `required`
- `email` (enum, optional, default: on)
  - Allowed values: `on`, `off`, `required`
- `inapp` (enum, optional, default: on)
  - Allowed values: `on`, `off`, `required`
- `push` (enum, optional, default: on)
  - Allowed values: `on`, `off`, `required`
- `slack` (enum, optional, default: on)
  - Allowed values: `on`, `off`, `required`
- `sms` (enum, optional, default: on)
  - Allowed values: `on`, `off`, `required`
- `teams` (enum, optional, default: on)
  - Allowed values: `on`, `off`, `required`
- `voice` (enum, optional, default: on)
  - Allowed values: `on`, `off`, `required`
- `webpush` (enum, optional, default: on)
  - Allowed values: `on`, `off`, `required`
- `whatsapp` (enum, optional, default: on)
  - Allowed values: `on`, `off`, `required`

### WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaResultSection1ItemsIsGlobalOptedOut

- `discord` (boolean, optional)
- `email` (boolean, optional)
- `inapp` (boolean, optional)
- `push` (boolean, optional)
- `slack` (boolean, optional)
- `sms` (boolean, optional)
- `teams` (boolean, optional)
- `voice` (boolean, optional)
- `webpush` (boolean, optional)
- `whatsapp` (boolean, optional)

### WsidVersionSubscriptionsPreferenceGetResponsesContentApplicationJsonSchemaResultSection1ItemsNotificationEventsItems

- `event_id` (string, optional)
- `event_name` (string, optional)

### preference_channels

- `discord` (enum, optional, default: opted-in)
  - Allowed values: `opted-out`, `opted-in`
- `email` (enum, optional, default: opted-in)
  - Allowed values: `opted-out`, `opted-in`
- `inapp` (enum, optional, default: opted-in)
  - Allowed values: `opted-out`, `opted-in`
- `push` (enum, optional, default: opted-in)
  - Allowed values: `opted-out`, `opted-in`
- `slack` (enum, optional, default: opted-in)
  - Allowed values: `opted-out`, `opted-in`
- `sms` (enum, optional, default: opted-in)
  - Allowed values: `opted-out`, `opted-in`
- `teams` (enum, optional, default: opted-in)
  - Allowed values: `opted-out`, `opted-in`
- `voice` (enum, optional, default: opted-in)
  - Allowed values: `opted-out`, `opted-in`
- `webpush` (enum, optional, default: opted-in)
  - Allowed values: `opted-out`, `opted-in`
- `whatsapp` (enum, optional, default: opted-in)
  - Allowed values: `opted-out`, `opted-in`

## Examples

**Response**

```json
{
  "meta": {
    "all": {
      "preference": {
        "discord": "opted-out",
        "email": "opted-out",
        "inapp": "opted-out",
        "push": "opted-out",
        "slack": "opted-out",
        "sms": "opted-out",
        "teams": "opted-out",
        "voice": "opted-out",
        "whatsapp": "opted-out"
      },
      "updated_at": {
        "discord": "string",
        "email": "string",
        "inapp": "string",
        "push": "string",
        "slack": "string",
        "sms": "string",
        "teams": "string",
        "voice": "string",
        "webpush": "string",
        "whatsapp": "string"
      }
    }
  },
  "result": {
    "Section1": [
      {
        "channel_config": {
          "discord": "on",
          "email": "on",
          "inapp": "on",
          "push": "on",
          "slack": "on",
          "sms": "on",
          "teams": "on",
          "voice": "on",
          "webpush": "on",
          "whatsapp": "on"
        },
        "description": "string",
        "is_global_opted_out": {
          "discord": true,
          "email": true,
          "inapp": true,
          "push": true,
          "slack": true,
          "sms": true,
          "teams": true,
          "voice": true,
          "webpush": true,
          "whatsapp": true
        },
        "name": "string",
        "notification_events": [
          {
            "event_id": "string",
            "event_name": "string"
          }
        ],
        "preference": {
          "discord": "opted-in",
          "email": "opted-in",
          "inapp": "opted-in",
          "push": "opted-in",
          "slack": "opted-in",
          "sms": "opted-in",
          "teams": "opted-in",
          "voice": "opted-in",
          "webpush": "opted-in",
          "whatsapp": "opted-in"
        },
        "subscription_id": "string",
        "updated_at": {
          "discord": "string",
          "email": "string",
          "inapp": "string",
          "push": "string",
          "slack": "string",
          "sms": "string",
          "teams": "string",
          "voice": "string",
          "webpush": "string",
          "whatsapp": "string"
        }
      }
    ]
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.fyno.io/v1/FYXXXXXXXX/version/subscriptions/preference"

querystring = {"distinct_id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","event_list":"false"}

headers = {"Authorization": "Bearer <apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.fyno.io/v1/FYXXXXXXXX/version/subscriptions/preference?distinct_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&event_list=false';
const options = {method: 'GET', headers: {Authorization: 'Bearer <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fyno.io/v1/FYXXXXXXXX/version/subscriptions/preference?distinct_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&event_list=false"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.fyno.io/v1/FYXXXXXXXX/version/subscriptions/preference?distinct_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&event_list=false")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.fyno.io/v1/FYXXXXXXXX/version/subscriptions/preference?distinct_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&event_list=false")
  .header("Authorization", "Bearer <apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.fyno.io/v1/FYXXXXXXXX/version/subscriptions/preference?distinct_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&event_list=false', [
  'headers' => [
    'Authorization' => 'Bearer <apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.fyno.io/v1/FYXXXXXXXX/version/subscriptions/preference?distinct_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&event_list=false");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.fyno.io/v1/FYXXXXXXXX/version/subscriptions/preference?distinct_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&event_list=false")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```