Skip to main content
POST
Get user watchlists (BFF V2)

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"8ce449bf-4624-4bb4-8c3c-ca1e6e19c8d1"

Body

application/json

BFF facade request selecting one or more components to resolve

version
integer<int32>
required

BFF request contract version

Required range: x >= 1
Example:

1

requestId
string
required

Caller-supplied correlation id for the BFF request

Example:

"d1aab7dd-8a63-4a64-9b9f-8b6c0e2e0f2a"

components
object[]
required

Components to resolve; must include a userWatchlists entry

Minimum array length: 1

Response

Successfully retrieved user watchlists as BFF component

BFF component envelope returned by watchlist V2 facade endpoints

kind
string
Example:

"component"

type
string

Component type

Example:

"userWatchlists"

status
string
Example:

"ok"

data
object

Component payload containing the user's watchlists and enrichment data

actions
object

Client actions available on the component, keyed by action name

meta
object

Component metadata, including the client cache directive

errors
object[]