---
title: "Retrieve inventory hits"
method: POST
path: "/api/inventory"
tags: ["api_other"]
---

# Retrieve inventory hits

`POST /api/inventory`

## Query parameters

- `includeAssetConfiguration` boolean

## Request body

- object
  - `filters` AssetSearchFilters
    - `assetState` string — Asset state filter (e.g., managed, unmanaged, ghost, drifted)
    - `assetTypes` string[] — List of asset types to filter by
    - `modifiedSince` string — Filter assets modified since this date (Format YYYY-MM-DD)
    - `freeTextSearch` string — Free text search query
    - `arns` string[] — List of ARNs to filter by
    - `frns` string[] — List of FRNs to filter by
    - `providerIds` string[] — List of provider IDs to filter by
    - `regions` string[] — List of regions to filter by
    - `names` string[] — List of asset names to filter by
    - `providerTypes` object
      - `providerType` string[]
      - `providerSubType` string[]
      - `provider` string[]
      - `integrationId` string[]
    - `tags` string[] — List of tags to filter by
    - `iacTypes` string[] — List of IaC types to filter by
    - `deleted` boolean — Include deleted assets
    - `includeConfiguration` boolean — Include asset configuration in response
    - `excludeIacTypes` string[] — List of IaC types to exclude
    - `excludeTags` string[] — List of tags to exclude
    - `excludeTypes` string[] — List of asset types to exclude
    - `excludeRegions` string[] — List of regions to exclude
    - `severity` PolicySeverity[]
    - `violatingPoliciesIds` string[] — List of policy IDs that are violated
    - `matchingExclusionRulesIds` string[] — List of matching exclusion IDs
    - `stackIds` string[] — List of stack IDs containing the assets
    - `owners` string[] — List of owners
    - `integrationIds` string[]
    - `hasMutations` boolean
    - `hasVCSLink` boolean
    - `hasComments` boolean
    - `deletedRange` string[]
    - `hasRelationship` boolean
    - `masterType` string[]
    - `isExcluded` boolean
    - `query` string — Query string to search for
  - `sorting` object
    - `field` string — Field name to sort by
    - `order` 'asc' | 'desc' — Sort direction
  - `size` integer — Number of results to return per page (max 10000)
  - `source` string[] — List of fields to include in the response
  - `afterKey` object — Pagination key for fetching next page of results
    - `sortField` string — Sort field value from the last result
    - `id` string — Unique identifier of the last result

## Response `200`

Successful response

- object
  - `responseObjects` Asset[]
    - `integrationId` string — The integration ID
    - `provider` string — The provider of the asset
    - `providerId` string — The provider ID
    - `assetId` string — The asset ID
    - `resourceId` string — The resource ID
    - `isExcluded` boolean — Whether the asset is excluded (matched by an exclusion id)
    - `lastConfigurationChangeTime` string — The time the asset configuration was last changed
    - `updatedAt` string — The time the asset was last updated
    - `matchingExclusionRuleIds` string[] — The exclusion rule IDs that match the asset
    - `state` 'modified' | 'managed' | 'child' | 'unmanaged' | 'ghost' | 'undetermined' | 'unknown' | 'pending' | 'deleted' | 'created' | 'iacIgnored'
    - `isChild` boolean — Whether the asset is a child resource
    - `frn` string — The FRN of the asset
    - `providerGroupId` string — The provider group ID (if applicable)
    - `firstSeen` string — The time the asset was first seen
    - `pendingTo` string — The pending state of the asset
    - `lastAssetStateChange` string — The time the asset's state was last changed
    - `subProvider` string — The sub-provider of the asset
    - `classificationsDetails` object — The classification details of the asset
      - `remediationCommands` string[]
      - `description` string
      - `monthlyCost` object
        - `currency` string
        - `value` number
    - `tags` object — The tags of the asset
      - `key` string
      - `value` string
    - `assetType` string — The type of the asset
    - `violationPolicyIds` string[] — List of violating governance policy IDs
    - `status` string
    - `stateUpdatedTime` string — The time the asset's state was last updated
    - `stackIds` unknown[]
      - unknown
    - `name` string
    - `location` string
    - `creationDate` integer
    - `deleteCommand` string
    - `consoleURL` string
    - `tagsList` string[]
    - `arn` string
    - `flywheelSummary` object
      - `requires_replace_items` string
      - `requires_replace` boolean
      - `drifts` string
      - `status` string
    - `taggingStatus` 'NOT_TAGGED' | 'TAGGED' | 'IRRELEVANT'
    - `pendingExpiration` string
    - `customColumns` object
      - `key` string
      - `value` string
    - `service` string
    - `lastActivity` Activity
      - `ActionType` string — Type of action performed
      - `eventTime` string — Timestamp of the event
      - `eventName` string — Name of the event
      - `userIdentity` UserIdentity
        - `customColor` string — Custom color associated with the user
        - `initials` string — User's initials
        - `displayName` string — Display name of the user
        - `type` 'IAMUser' — Type of user identity
      - `eventId` string — Event identifier
    - `providerSubType` string
    - `creationTime` string
    - `id` string
    - `revisionCount` integer
    - `iac` object
      - `type` string — Type of IAC
      - `stackName` string
      - `stackIds` string[]
      - `activeStackId` string
      - `firstSeen` string
      - `moduleAddress` string
      - `objectName` string
      - `objectFullAddresses` string
      - `stateLocation` string — Location of the state file
    - `vcs` object
      - `id` string
      - `codeLink` string
      - `codeFileLink` string
      - `provider` string
      - `repo` string
      - `workingDirectory` string
  - `totalObjects` integer
  - `afterKey` object — The key to use for the next page of results
    - `sortField` string — Sort field value from the last result
    - `id` string — Unique identifier of the last result

## Other responses

- `400` — Bad Request Error
- `401` — Unauthorized Error
- `500` — Internal Server Error

---

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