---
title: "Search"
method: GET
path: "/landscapes/{landscapeId}/versions/{versionId}/search"
tags: ["Landscape"]
---

# Search

`GET /landscapes/{landscapeId}/versions/{versionId}/search`

Search the entire landscape

## Path parameters

- `landscapeId` string, required
- `versionId` string, required

## Query parameters

- `search` string, required
- `filter` SearchFilter
  - `type` union
    - 'actor' | 'app' | 'component' | 'group' | 'root' | 'store' | 'system' | 'app-diagram' | 'component-diagram' | 'context-diagram' | 'connection' | 'flow'
    - SearchIndexType[]
- `includeData` boolean
- `maxResults` number

## Response `200`

OK

- object
  - `results` SearchResult[], required
    - `data` union
      - ModelObject
        - `caption` string — Short summary of the object shown as the display description
        - `commit` number, required
        - `description` string
        - `external` boolean, required
        - `groupIds` string[], required — IDs of the groups this model object belongs to
        - `icon` ModelObjectIconNullable, required
          - `catalogTechnologyId` string, required
          - `name` string, required
          - `url` string — Use either urlDark or urlLight
          - `urlDark` string — Icon that only works on dark backgrounds
          - `urlLight` string — Icon that only works on light backgrounds
        - `labels` object, required — Generic key value store used for creating custom integrations
        - `links` object, required
        - `name` string, required
        - `parentId` string, nullable, required — Parent model object ID, null for the root level model object
        - `status` 'deprecated' | 'future' | 'live' | 'removed', required
        - `tagIds` string[], required — Tag IDs assigned to this model
        - `teamIds` string[], required — Team IDs that own this model object, does not propergate up or down
        - `teamOnlyEditing` boolean, required — Model object (+child diagram, diagram groups and flows) can only be edited by owners and admins
        - `technologyIds` string[], required — Technology IDs assigned to this model
        - `type` 'actor' | 'app' | 'component' | 'group' | 'root' | 'store' | 'system', required
        - `domainId` string, required
        - `handleId` string, required
        - `childDiagramIds` string[], required — Child diagram IDs
        - `childIds` string[], required — Child model object IDs, only one level down
        - `createdAt` string, date-time, required
        - `createdBy` 'user' | 'api-key' | 'notification-key' | 'service', required
        - `createdById` string, required
        - `deletedAt` string, date-time
        - `deletedBy` 'user' | 'api-key' | 'notification-key' | 'service'
        - `deletedById` string
        - `diagrams` object, required
        - `flows` object, required
        - `id` string, required
        - `landscapeId` string, required
        - `latestEntityId` string
        - `linked` boolean, required
        - `parentIds` string[], required — Parent model object IDs for the whole hierarchy, ending with the root model object
        - `updatedAt` string, date-time, required
        - `updatedBy` 'user' | 'api-key' | 'notification-key' | 'service', required
        - `updatedById` string, required
        - `version` number, required
        - `versionId` string, required
      - ModelConnection
        - `commit` number, required
        - `description` string
        - `direction` 'outgoing' | 'bidirectional', required
        - `labels` object, required
        - `links` object, required
        - `name` string, required
        - `originId` string, required — Model object that initiates the connection
        - `status` 'deprecated' | 'future' | 'live' | 'removed', required
        - `tagIds` string[], required — Tag IDs assigned to this model
        - `targetId` string, required — Model object that receives the message
        - `technologyIds` string[], required — Technology IDs assigned to this model
        - `viaId` string, nullable, required — Model object that facilitates the connection, such as a Kafka topic, or RabbitMQ queue
        - `handleId` string, required
        - `createdAt` string, date-time, required
        - `createdBy` 'user' | 'api-key' | 'notification-key' | 'service', required
        - `createdById` string, required
        - `deletedAt` string, date-time
        - `deletedBy` 'user' | 'api-key' | 'notification-key' | 'service'
        - `deletedById` string
        - `diagrams` object, required
        - `flows` object, required
        - `id` string, required
        - `landscapeId` string, required
        - `latestEntityId` string
        - `linked` boolean, required
        - `updatedAt` string, date-time, required
        - `updatedBy` 'user' | 'api-key' | 'notification-key' | 'service', required
        - `updatedById` string, required
        - `version` number, required
        - `versionId` string, required
      - Diagram
        - `commit` number, required
        - `description` string
        - `groupId` string, nullable, required
        - `index` number, required
        - `labels` object, required
        - `modelId` string, required — model object id this object belongs to
        - `name` string, required
        - `parentId` string, nullable, required
        - `pinned` boolean, required
        - `pinnedAt` string, date-time
        - `pinnedIndex` number
        - `status` 'current', required
        - `zoomOverrides` DiagramZoomOverridesNullable — Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id.
        - `handleId` string, required
        - `type` 'app-diagram' | 'component-diagram' | 'context-diagram', required
        - `commentCount` number, required
        - `connectionCount` number, required
        - `createdAt` string, date-time, required
        - `createdBy` 'user' | 'api-key' | 'notification-key' | 'service', required
        - `createdById` string, required
        - `deletedAt` string, date-time
        - `deletedBy` 'user' | 'api-key' | 'notification-key' | 'service'
        - `deletedById` string
        - `id` string, required
        - `landscapeId` string, required
        - `latestEntityId` string
        - `objectCount` DiagramObjectCount, required
          - `actor` number, required
          - `app` number, required
          - `group` number, required
          - `component` number, required
          - `store` number, required
          - `system` number, required
          - `area` number, required
          - `box` number, required
        - `updatedAt` string, date-time, required
        - `updatedBy` 'user' | 'api-key' | 'notification-key' | 'service', required
        - `updatedById` string, required
        - `version` number, required
        - `versionId` string, required
      - Flow
        - `commit` number, required
        - `index` number, required
        - `labels` object, required
        - `name` string, required
        - `pinned` boolean, required
        - `pinnedAt` string, date-time
        - `pinnedIndex` number
        - `showAllSteps` boolean, required
        - `showConnectionNames` boolean, required
        - `steps` object, required
        - `diagramId` string, required
        - `handleId` string, required
        - `createdAt` string, date-time, required
        - `createdBy` 'user' | 'api-key' | 'notification-key' | 'service', required
        - `createdById` string, required
        - `deletedAt` string, date-time
        - `deletedBy` 'user' | 'api-key' | 'notification-key' | 'service'
        - `deletedById` string
        - `id` string, required
        - `landscapeId` string, required
        - `latestEntityId` string
        - `updatedAt` string, date-time, required
        - `updatedBy` 'user' | 'api-key' | 'notification-key' | 'service', required
        - `updatedById` string, required
        - `version` number, required
        - `versionId` string, required
        - `viewedAt` string, date-time
        - `viewedBy` 'user' | 'api-key' | 'notification-key' | 'service'
        - `viewedById` string
    - `id` string, required
    - `name` string, required
    - `score` number, required
    - `type` 'actor' | 'app' | 'component' | 'group' | 'root' | 'store' | 'system' | 'app-diagram' | 'component-diagram' | 'context-diagram' | 'connection' | 'flow', required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity
- `429` — Resource Exhausted
- `500` — Internal Server

---

[API](https://skmtc.net/icepanel/apis/icepanel-api.md) · [All operations](https://skmtc.net/icepanel/apis/icepanel-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/icepanel/icepanel-api/revisions/e9ab2ff0f435/schema)