---
title: "Get a list of entities by type. A returned empty list indicates no entities matched the given parameters."
method: GET
path: "/v1/entities"
tags: ["entities"]
---

# Get a list of entities by type. A returned empty list indicates no entities matched the given parameters.

`GET /v1/entities`

## Query parameters

- `type` string
- `name` string
- `search` string
- `pageSize` integer
- `skipToken` string

## Response `200`

The request has succeeded.

- object
  - `entities` EntitiesEntity[], required — List of matching entities.
    - `id` string, required — The ID of the entity.
    - `type` string, required — The type of the entity.
    - `name` string — The name of the entity.
    - `displayName` string, nullable — Entity display name / alias. This value is equal to name unless it is explicitly overridden.
    - `createdTime` string, date-time — Date and time of entity creation in UTC.
    - `updatedTime` string, date-time — Date and time of last entity update in UTC.
    - `lastSeenTime` string, date-time, required — Date and time when the entity has last received telemetry in UTC.
    - `inMaintenance` boolean, required — Flag telling if given entity is in maintenance mode.
    - `healthscore` EntitiesHealthScore
      - `score` integer — Health score value from 0 to 100.
      - `category` 'good' | 'bad' | 'moderate' — Health Score category label.
    - `healthState` EntitiesHealthState
      - `state` 'GOOD' | 'MODERATE' | 'AT_RISK' | 'DEGRADED' | 'BAD' | 'UNKNOWN' | 'DISABLED', nullable — Health state of the entity.
    - `tags` object, required — Entity tags. Tag is a key-value pair, where there may be only a single tag value for the same key.
    - `attributes` object — Map of available attributes.
  - `pageInfo` CommonPageInfo, required
    - `prevPage` string, required — Token for the previous page, or empty string if on the first page.
    - `nextPage` string, required — Token for the next page, or empty string if on the last page.

## Other responses

- `400` — The server could not understand the request due to invalid syntax.
- `401` — Access is unauthorized.
- `500` — Server error

---

[API](https://skmtc.net/solarwinds/apis/solarwinds-observability.md) · [All operations](https://skmtc.net/solarwinds/apis/solarwinds-observability/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/solarwinds/solarwinds-observability/versions/994e5ca64961/schema)