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

# Get watchlist dashboard

> Returns a bundled dashboard for a single watchlist: event breakdown by entity type, total/unacknowledged event counts, latest event timestamp, and the most recent events with entity details. Avoids several round-trips the UI would otherwise need.

<Badge color="green" size="sm">Pro+ tier</Badge>


## OpenAPI

````yaml get /watchlists/{id}/dashboard
openapi: 3.1.1
info:
  title: TIC Lens API
  description: "The TIC Lens API provides programmatic access to company, person, property, vehicle, and order data.\r\n\r\n## Authentication\r\n\r\nAll requests require an API key passed via the `x-api-key` header:\r\n\r\n```bash\r\ncurl -H \"x-api-key: YOUR_API_KEY\" https://lens-api.tic.io/companies/123\r\n```\r\n\r\nAPI keys are managed through the TIC Lens web application under **Settings → API Keys**.\r\n\r\n## Base URL\r\n\r\n| Environment | URL |\r\n|-------------|-----|\r\n| Production  | `https://lens-api.tic.io` |\r\n\r\n## Feature Access\r\n\r\nEndpoints are gated by your subscription plan. If your plan does not include a feature, the endpoint will return `403 Forbidden`.\r\n\r\n## Rate Limits\r\n\r\nRate limits are applied per API key. If you exceed the limit, requests will return `429 Too Many Requests`.\r\n\r\n## Response Format\r\n\r\nAll responses are JSON. Null values are omitted from responses.\r\n"
  version: v1
servers:
  - url: https://lens-api.tic.io
security:
  - ApiKey: []
tags:
  - name: Addresses
  - name: Bolagsverket
  - name: Brf
  - name: Companies
  - name: Documents
  - name: FlightImages
  - name: Free
  - name: Orders
  - name: OrdersExports
  - name: PaymentControl
  - name: PaymentControlImport
  - name: Persons
  - name: Properties
  - name: PublicSearch
  - name: SearchAutocomplete
  - name: Sentinel
  - name: ServingPermits
  - name: Team
  - name: Teams
  - name: Transportstyrelsen
  - name: Vehicles
  - name: WatchList
paths:
  /watchlists/{id}/dashboard:
    get:
      tags:
        - WatchList
      summary: Get watchlist dashboard
      description: >-
        Returns a bundled dashboard for a single watchlist: event breakdown by
        entity type, total/unacknowledged event counts, latest event timestamp,
        and the most recent events with entity details. Avoids several
        round-trips the UI would otherwise need.
      operationId: GetWatchListDashboard
      parameters:
        - name: id
          in: path
          description: Watchlist GUID
          required: true
          schema:
            type: string
            format: uuid
        - name: recentEventCount
          in: query
          description: Number of recent events to include (1–25, default 10)
          schema:
            type: integer
            format: int32
            default: 10
      responses:
        '200':
          description: Dashboard bundle
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Ormeo_Web_Lens_Models_WatchList_WatchListDashboard_Dto
        '404':
          description: Watchlist not found in this team
components:
  schemas:
    Ormeo_Web_Lens_Models_WatchList_WatchListDashboard_Dto:
      type: object
      properties:
        watchListGuid:
          type: string
          format: uuid
        watchListName:
          type:
            - 'null'
            - string
        watchListDescription:
          type:
            - 'null'
            - string
        lastUpdatedAtUtc:
          type: string
          format: date-time
        lastEventAtUtc:
          type:
            - 'null'
            - string
          format: date-time
        recentEvents:
          type:
            - 'null'
            - array
          items:
            $ref: >-
              #/components/schemas/Ormeo_Web_Lens_Models_WatchList_WatchListRecentEvent_Dto
        eventBreakdown:
          $ref: >-
            #/components/schemas/Ormeo_Web_Lens_Models_WatchList_WatchListEventBreakdown_Dto
        totalMembers:
          type: integer
          format: int32
        unacknowledgedEventCount:
          type: integer
          format: int32
      additionalProperties: false
    Ormeo_Web_Lens_Models_WatchList_WatchListRecentEvent_Dto:
      type: object
      properties:
        eventId:
          type: integer
          format: int32
        memberGuid:
          type: string
          format: uuid
        eventType:
          $ref: '#/components/schemas/Ormeo_Library_Entities_WatchListMemberEventType'
        subType:
          type:
            - 'null'
            - string
        eventDate:
          type: string
          format: date-time
        isAcknowledged:
          type: boolean
        entityType:
          type:
            - 'null'
            - string
        entityName:
          type:
            - 'null'
            - string
        entityId:
          type:
            - 'null'
            - integer
          format: int32
      additionalProperties: false
    Ormeo_Web_Lens_Models_WatchList_WatchListEventBreakdown_Dto:
      type: object
      properties:
        companyEvents:
          type: integer
          format: int32
        personEvents:
          type: integer
          format: int32
        addressEvents:
          type: integer
          format: int32
        propertyEvents:
          type: integer
          format: int32
        vehicleEvents:
          type: integer
          format: int32
        totalEvents:
          type: integer
          format: int32
      additionalProperties: false
    Ormeo_Library_Entities_WatchListMemberEventType:
      enum:
        - companyAddress
        - companyName
        - companyStatus
        - companyRegistration
        - companyIntelligence
        - companyBeneficialOwner
        - companyDocument
        - companyWorkplace
        - companyPerson
        - companyRegisteredOffice
        - companyShareCapital
        - companyPurpose
        - companyDebtBalance
        - companyOrderToPayCase
        - companyFinancialDocument
        - companyCase
        - companyWorkplaceAddress
        - unused_Company4
        - unused_Company5
        - unused_Company6
        - unused_Company7
        - unused_Company8
        - unused_Company9
        - unused_Company10
        - personAddress
        - personName
        - personIntelligence
        - personStatus
        - personCompany
        - unused_Person1
        - unused_Person2
        - unused_Person3
        - unused_Person4
        - unused_Person5
        - unused_Person6
        - unused_Person7
        - unused_Person8
        - unused_Person9
        - unused_Person10
        - propertyOwnershipChange
        - propertyMortageDeedChange
        - unused_Property1
        - unused_Property2
        - unused_Property3
        - unused_Property4
        - unused_Property5
        - vehicleOwnerChange
        - vehicleUserChange
        - vehicleStatusChange
        - vehicleInspection
        - vehicleStolen
        - unused_Vehicle1
        - unused_Vehicle2
        - unused_Vehicle3
        - unused_Vehicle4
        - unused_Vehicle5
      type: string
  securitySchemes:
    ApiKey:
      type: apiKey
      name: x-api-key
      in: header

````