Get Preferences

GET/api/v1/inbox/preferences

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Responses

200Successful Response

successboolean

default: true

dataPreferencesView | any

Show properties

Any of:

PreferencesView

preferencesNotificationPreferencesrequired

Which channels a person wants per kind; an absent kind takes `DEFAULT_CHANNELS`. Its own collection because `UsersRepository.upsert` replaces the whole user mirror on every Clerk `user.updated` webhook, wiping any field not on the `User` model.

Show properties

idstringrequired

channelsobject

muted_topicsobject

updated_atstring<date-time>

slack_kindsNotificationKind[]required

topicsobjectrequired

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

Request

curl -X GET "/api/v1/inbox/preferences" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/inbox/preferences", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/inbox/preferences",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "preferences": {
      "id": "string",
      "channels": {
        "property1": [
          "inbox"
        ],
        "property2": [
          "inbox"
        ]
      },
      "muted_topics": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "slack_kinds": [
      "comment_mention"
    ],
    "topics": {
      "property1": [
        "string"
      ],
      "property2": [
        "string"
      ]
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}