Skip to main content
POST
/
preferences
/
list
Get user preferences
curl --request POST \
  --url https://alerts.platform.arb.inc/preferences/list \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "docket_filings",
    "title": "Docket Filings",
    "description": "Whether to receive alerts when new docket filings occur",
    "type": "boolean",
    "value": "true"
  }
]

Authorizations

​
Authorization
string
header
required

access token

Response

200 - application/json

Successfully retrieved user preferences.

​
id
string

Unique identifier for the preference

Example:

"docket_filings"

​
title
string

Human-readable title of the preference

Example:

"Docket Filings"

​
description
string

Detailed description of what the preference controls

Example:

"Whether to receive alerts when new docket filings occur"

​
type
enum<string>

Data type of the preference value

Available options:
boolean,
string,
number
Example:

"boolean"

​
value
string

Current value of the preference as a string

Example:

"true"