---
title: "List views"
url: "https://developer-beta.morningstar.com/apis/investment-details-feed-api/versions/bc1f8f4b-464c-40a5-af50-a06cce9f3980/operations/getViews"
---

> Full API specification: https://developer-beta.morningstar.com/apis/investment-details-feed-api/versions/bc1f8f4b-464c-40a5-af50-a06cce9f3980.md

# List views

`GET` `/direct-web-services/v1/investments/views`

Operation ID: `getViews`

Retrieve the list of data views your account is entitled to access, along with the corresponding `viewId` values required to request investment details.

## Responses

- `200` - OK
- `400` - 400
- `500` - 500

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Investment Details Feed API
  version: "1.0"
servers:
  - url: https://www.us-api.morningstar.com
    description: Americas
  - url: https://www.apac-api.morningstar.com
    description: APAC
  - url: https://www.emea-api.morningstar.com
    description: EMEA
paths:
  /direct-web-services/v1/investments/views:
    get:
      tags:
        - Utility Endpoints
      summary: List views
      description: |-
        Retrieve the list of data views your account is entitled to access,
        along with the corresponding `viewId` values required to request
        investment details.
      operationId: getViews
      responses:
        "200":
          $ref: "#/components/responses/ResponseListViews"
        "400":
          $ref: "#/components/responses/ResponseBadRequest"
        "500":
          $ref: "#/components/responses/ResponseInternalServerError"
security:
  - Bearer: []
components:
  responses:
    ResponseListViews:
      description: OK
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ResponseListViews"
    ResponseBadRequest:
      description: "400"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OutputErrorDetails"
    ResponseInternalServerError:
      description: "500"
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OutputErrorDetails"
  schemas:
    ResponseListViews:
      title: ResponseListViews
      type: object
      description: >
        Response containing entitled view packages and their associated dataset
        viewIds.
      required:
        - views
        - metadata
      properties:
        views:
          type: array
          description: List of entitled view packages and their datasets.
          items:
            $ref: "#/components/schemas/OutputViewDetails"
        metadata:
          $ref: "#/components/schemas/OutputMetadata"
      additionalProperties: false
    OutputErrorDetails:
      type: object
      properties:
        statusCode:
          type: integer
          description: Status Code
          format: int32
        errorCode:
          type: string
          description: Custom error code
          nullable: true
        message:
          type: string
          description: Message
          nullable: true
        requestId:
          type: string
          description: RequestId
          nullable: true
      additionalProperties: false
      description: Error details
      title: OutputErrorDetails
    OutputViewDetails:
      title: OutputViewDetails
      type: object
      description: A view package and the dataset viewIds it contains.
      required:
        - package
        - datasets
      properties:
        package:
          $ref: "#/components/schemas/OutputViewPackage"
        datasets:
          type: array
          description: Dataset viewIds included in this package.
          items:
            $ref: "#/components/schemas/OutputViewDataset"
          minItems: 0
      additionalProperties: false
    OutputMetadata:
      type: object
      properties:
        requestId:
          type: string
          nullable: true
        time:
          type: string
          format: date-time
          readOnly: true
        portfolioDate:
          type: string
          nullable: true
        portfolioCurrency:
          type: string
          nullable: true
        messages:
          type: array
          items:
            $ref: "#/components/schemas/OutputMetadataMessages"
          nullable: true
      additionalProperties: false
      title: OutputMetadata
    OutputViewPackage:
      title: OutputViewPackage
      type: object
      description: Identifies the entitled package-level view.
      required:
        - viewId
      properties:
        viewId:
          $ref: "#/components/schemas/OutputViewId"
      additionalProperties: false
    OutputViewDataset:
      title: OutputViewDataset
      type: object
      description: Identifies a dataset viewId associated with a package.
      required:
        - viewId
      properties:
        viewId:
          $ref: "#/components/schemas/OutputViewId"
      additionalProperties: false
    OutputMetadataMessages:
      type: object
      properties:
        type:
          type: string
          nullable: true
        code:
          type: string
          nullable: true
        investments:
          type: array
          items:
            $ref: "#/components/schemas/OutputInvalidInvestments"
          nullable: true
        message:
          type: string
          nullable: true
      additionalProperties: false
      title: OutputMetadataMessages
    OutputViewId:
      title: OutputViewId
      type: string
      description: >
        Identifier of an entitled view or dataset. Use this value as `viewId` in
        investment detail requests.
      minLength: 1
      example: equity-short-interest
    OutputInvalidInvestments:
      type: object
      properties:
        id:
          type: string
          nullable: true
        idType:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        datapointId:
          type: array
          items:
            type: string
          nullable: true
        errorCode:
          type: string
          nullable: true
        performanceId:
          type: string
          description: Performance ID (if not passed in request).
          nullable: true
        companyId:
          type: string
          description: Company ID (if not passed in request).
          nullable: true
        baseCurrency:
          type: string
          description: Input base currency used to look up Investment identifier
          nullable: true
        domicile:
          type: string
          description: Input domicile used to look up Investment identifier.
          nullable: true
        exchangeCountry:
          type: string
          description: Input exchange country used to look up Investment identifier.
          nullable: true
        exchangeId:
          type: string
          description: Input exchange id used to look up Investment identifier.
          nullable: true
      additionalProperties: false
      title: OutputInvalidInvestments
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: "JWT obtained from `POST /token/oauth`. Send it on every request as
        `Authorization: Bearer <token>`. Reuse the token for up to 60 minutes,
        then request a new one."
```