> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wealthyhood.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get watchlist

> Return the user's watchlist.



## OpenAPI

````yaml GET /b2b/watchlists
openapi: 3.0.3
info:
  title: Wealthyhood Watchlists API
  version: 1.0.0
  description: >
    B2B API endpoints for a user's investment watchlist. Each user has one
    watchlist. Assets are stored

    by their Wealthyhood `assetCommonId`.


    All requests require a bearer access token with the advertised scopes, and
    must include the `x-user-id`

    header to identify the user whose watchlist is being read or updated.


    Adding an asset that is already on the watchlist is a no-op and still
    returns the watchlist. Removing

    an asset that is not on the watchlist is also a no-op.
servers:
  - url: https://{host}
    variables:
      host:
        default: api.wealthyhood.com
        description: Wealthyhood API host name.
security:
  - bearerAuth: []
tags:
  - name: Watchlists
    description: Read and update a user's investment watchlist.
paths:
  /b2b/watchlists:
    get:
      tags:
        - Watchlists
      summary: Get watchlist
      description: >
        Returns the authenticated user's watchlist. The watchlist is created
        when the user signs up.
      parameters:
        - $ref: '#/components/parameters/ExternalUserId'
      responses:
        '200':
          description: Watchlist retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Watchlist'
              example:
                id: 7501d8537fb3fc001234abcd
                assets:
                  - assetCommonId: equities_apple
                createdAt: '2026-07-15T10:00:00.000Z'
                updatedAt: '2026-07-15T10:00:00.000Z'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  parameters:
    ExternalUserId:
      name: x-user-id
      in: header
      required: true
      description: >-
        MongoDB identifier of the user whose watchlist is being accessed or
        updated.
      schema:
        type: string
        pattern: ^[a-f0-9]{24}$
        example: 507f1f77bcf86cd799439011
  schemas:
    Watchlist:
      type: object
      required:
        - id
        - assets
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        assets:
          type: array
          items:
            $ref: '#/components/schemas/WatchlistAsset'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    WatchlistAsset:
      type: object
      required:
        - assetCommonId
      properties:
        assetCommonId:
          type: string
          description: Investment universe asset identifier.
    ApiErrorResponse:
      type: object
      properties:
        status:
          type: integer
        error:
          type: object
          properties:
            message:
              type: string
            description:
              type: string
        responseId:
          type: string
  responses:
    BadRequestError:
      description: Invalid request parameters or business rule violation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorResponse'
    UnauthorizedError:
      description: Missing or invalid bearer token, or user not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorResponse'
    NotFoundError:
      description: Watchlist not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Auth0-issued access token that includes the scopes listed for the
        endpoint.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.