---
title: "Retrieve a paginated list of entity summaries"
method: POST
path: "/entities"
tags: ["Monitoring: Entity Management"]
---

# Retrieve a paginated list of entity summaries

`POST /entities`

Use this endpoint to browse your monitored entity population. It is filterable and shows all of your entities at a glance.

## Query parameters

- `sortBy` string, nullable — The field name that you want to sort by. Many fields in the response are sortable, but not all.
- `sortOrder` string, nullable — ASC or DESC. Defaults: DESC
- `page` integer — Page number, 1-indexed. Default: 1
- `pageSize` integer — Number of results per page. Maximum: 100, Default: 10

## Request body

- RequestEntitiesRequestPublic
  - `filters` string[], nullable
  - `page` integer — Page number, 1-indexed. Default: 1
  - `pageSize` integer — Number of results per page. Maximum: 100, Default: 10
  - `sortBy` string, nullable — The field name that you want to sort by. Many fields in the response are sortable, but not all.
  - `sortOrder` string, nullable — ASC or DESC. Defaults: DESC
  - `total` integer — Total number of results. Ignored in requests, used in responses.

## Response `200`

OK

- ResponsePaginatedEntitySummaries
  - `entities` ResponseEntitySummary[], nullable
    - `archivedAt` string, date-time, nullable — Not null if the entity has been archived. The time when the entity was archived
    - `createdAt` string, date-time
    - `customFields` SigmaidCustomEntityField[], nullable — User-provided metadata, any format. Does not affect matching, risk, or profile data.
      - `key` string
      - `value` string
    - `customerKey` string — Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.
    - `dispositionState` ResponseEntityDispositionState
      - `dispositionSetAtTime` string, date-time, nullable — The time when the disposition was last set
      - `dispositionSetByUserName` string, nullable — The name of the user who last set the disposition
      - `dispositionSetByUserURN` string, nullable — The URN of the user who last set the disposition
      - `dispositionState` string — The current disposition state of the entity. Should be unsnaked and titlecased before UI display
    - `entityGroups` ResponseMinimalEntityGroup[], nullable
      - `entityGroupName` string
      - `id` integer
    - `entityName` string
    - `entitySources` CommonEntitySource[], nullable — Describes which job or action created the entity
      - `sourceID` string — The ID of the process run that created the entity
      - `sourceType` string — Which kind of process created or referenced the entity
    - `entityType` 'company' | 'person' | 'vessel' | 'aircraft' | '', nullable — The resolved entity type
    - `escalated` boolean
    - `escalatedByUserName` string, nullable
    - `escalatedByUserUrn` string, nullable
    - `escalatedTime` string, date-time, nullable
    - `filterSetID` integer
    - `filterSetName` string
    - `hasOpenAlert` boolean — Whether the entity has an open alert
    - `indicatorSummaries` SigmaidIndicatorSummary[], nullable — The summary of the indicators that are currently active
      - `category` string
      - `count` integer
      - `isNetwork` boolean — Indicates whether the indicator is describes this entity or one of its network connections
      - `maxScore` integer
    - `monitored` boolean — Whether the entity will receive automated data and risk updates
    - `notes` ResponseNote[], nullable — The user-provided notes that have been added to the entity
      - `entityUrn` string
      - `id` integer
      - `note` string
      - `updatedAt` string, date-time
      - `userName` string
      - `userUrn` string
    - `organizationURN` string — The primary identifier for the organization that owns the entity
    - `reviewState` ResponseEntityReviewState
      - `isAllowedToEndReview` boolean — Whether the current user is allowed to cancel / submit a review
      - `isEditingLocked` boolean — Whether the current user is allowed to change this entity
      - `lastReviewDate` string, date-time, nullable — Time of the last review submission
      - `reviewLockedByName` string, nullable — The name of the user who locked the entity for review
      - `reviewLockedByURN` string, nullable — The URN of the user who locked the entity for review
      - `reviewLockedSince` string, date-time, nullable — The time when the entity was locked for review
      - `reviewStatus` 'no_review_necessary' | 'needs_review' | 'review_locked' | 'reviewed'
      - `unreviewedItems` ResponseUnreviewedItems
        - `numIndicators` integer — The number of indicators inside the entity that require review
        - `numMatches` integer — The number of matches inside the entity that require review
        - `numNews` integer — The number of news events inside the entity that require review
        - `total` integer — The number of items inside the entity that require review
    - `riskMetadata` ResponseRiskMetadata
      - `newsMetadata` ResponseNewsMetadata[], nullable — The news events that are currently detected
        - `count` integer — The number of news events for this type that are currently detected
        - `eventNewsType` string — The event news type currently detected
        - `samplePublishers` string[], nullable — A sample of the publishers that are currently detected
        - `unformattedEventNewsType` string — The unformatted event news type currently detected
      - `pepLevels` string[], nullable — The PEP levels that are currently detected
      - `sanctionLists` string[], nullable — The sanction lists that are currently detected
    - `riskScore` integer — The risk from 0 to 100, where 0 is the lowest risk and 100 is the highest risk
    - `searchParameters` SigmaidBasicSearchParams
      - `aliases` string[], nullable — Secondary names to perform a search on
      - `countries` string[], nullable — ISO 3166-1 alpha-2
      - `customFields` SigmaidCustomEntityField[], nullable — Optional. A list of custom fields to be associated with the entity for cross-referencing or disambiguation in alerts and monitoring. Does not affecting risk or matching logic. Each field must have a unique key.
        - `key` string
        - `value` string
      - `customerKey` string — Optional. A user-provided identifier that will be returned in alerts and monitoring. Any format.
      - `dob` string, nullable — Birth or foundation date. YYYY, YYYY-MM, YYYY-MM-DD, YYYY/MM or YYYY/MM/DD format.
      - `entityName` string, required — The primary name of the search
      - `entityType` 'person' | 'company' | 'aircraft' | 'vessel', nullable
    - `updatedAt` string, date-time
    - `urn` string — The primary identifier for user-created entities
  - `page` integer — Page number, 1-indexed. Default: 1
  - `pageSize` integer — Number of results per page. Maximum: 100, Default: 10
  - `total` integer — Total number of results. Ignored in requests, used in responses.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.dev/sigma360/apis/sigma360-api.md) · [All operations](https://skmtc.dev/sigma360/apis/sigma360-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sigma360/sigma360-api/revisions/fcdda6232c62/schema)