---
title: "List assets"
method: GET
path: "/assets"
tags: ["Assets"]
---

# List assets

`GET /assets`

## Request

- Base URL: `https://public.escape.tech/v3`
- URL: `https://public.escape.tech/v3/assets`
- Auth: API key in header `X-ESCAPE-API-KEY`

List and search assets of the organization.

## Query parameters

- `cursor` string: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.
- `size` integer: The number of items to return per page
- `sortType` 'DOMAIN' | 'ENDPOINTS_COUNT' | 'FIRST_SEEN' | 'LAST_SEEN' | 'NAME' | 'PORTS' | 'SEVERITY' | 'TYPE' | 'USED_BY_COUNT': The type to sort by
- `sortDirection` 'asc' | 'desc': The direction to sort by
- `search` string: Search term to filter assets by name or description
- `types` string[]: Filter by type
- `statuses` string[]: Filter by status
- `projectIds` union: Filter by any of the listed project IDs
  - string
  - string[]
- `tagIds` union: Filter by any of the listed tag IDs
  - string
  - string[]
- `classes` string[]: Filter by class
- `environments` string[]: Filter by environment
- `domains` union: Filter by domain
  - string
  - string[]
- `integrationIds` union: Filter by source integration ID
  - string
  - string[]
- `ownerEmails` union: Filter by owner email
  - string
  - string[]
- `technologyKeys` union: Filter by technology key
  - string
  - string[]
- `ports` union: Filter by port number
  - string
  - union[]
    - union
      - string
      - number
- `severities` string[]: Filter by severity
- `risks` string[]: Filter by risk
- `frameworks` string[]: Filter by framework
- `manuallyCreated` 'true' | 'false': Filter by manually created
- `dnf` string: Filter by DNF expression

## Response `200`

OK

- object
  - `nextCursor` string, nullable, required
  - `totalCount` integer
  - `data` object[], required
    - `id` string, uuid, required: The id of the asset
    - `class` 'API_SERVICE' | 'CDN' | 'CLOUD_COMPONENT' | 'CLOUD_HOSTING' | 'CODE_PROJECT' | 'CSPM' | 'DEV_TOOLS' | 'FRONTEND' | 'HOST' | 'MOBILE_APP' | 'NETWORK' | 'REPOSITORY' | 'SCHEMA' | 'SOURCE_CODE_MANAGEMENT' | 'TECHNOLOGY', required: The class of the asset
    - `type` 'APK' | 'AWS_LAMBDA' | 'BITBUCKET_REPOSITORY' | 'BURPSUITE_EXPORT' | 'CODE_PROJECT' | 'DNS' | 'GITHUB_REPOSITORY' | 'GITLAB_REPOSITORY' | 'GRAPHQL' | 'GRAPHQL_SCHEMA' | 'GRPC' | 'HAR_EXPORT' | 'INSOMNIA' | 'IPV4' | 'IPV4_RANGE' | 'IPV6' | 'MCP' | 'OPENAPI' | 'PACKAGE' | 'POSTMAN_COLLECTION' | 'POSTMAN_ENVIRONMENT' | 'REST' | 'SOAP' | 'SOFTWARE' | 'WEBAPP' | 'WEBSOCKET' | 'WP_JSON', required: The type of the asset
    - `name` string, required: The name of the asset
    - `externalUrl` string, nullable, required: The external url of the asset
    - `faviconUrl` string, nullable, required: The favicon url of the asset
    - `createdAt` string, required: The date and time the asset was created
    - `lastSeenAt` string, required: The date and time the asset was last seen
    - `scheduledForDeletionAt` string, nullable, required: The date and time the asset is scheduled for deletion
    - `status` 'DEPRECATED' | 'FALSE_POSITIVE' | 'MONITORED' | 'OUT_OF_SCOPE' | 'THIRD_PARTY', required: The status of the asset
    - `tags` object[], required: The tags of the asset
      - `id` string, uuid, required: The id of the tag
      - `name` string, required: The name of the tag
      - `color` string, required: The color of the tag
    - `risks` string[], required: The risks of the asset
    - `projectIds` string[], required: IDs of the projects this asset is assigned to
    - `owners` string[]: Email addresses of the owners of this asset.
    - `service` object, nullable, required: The service of the asset
      - `url` string, required: The url of the asset service
      - `type` 'GRAPHQL' | 'GRPC' | 'MCP' | 'REST' | 'SOAP' | 'WEBSOCKET', required: The type of the asset service
    - `frontend` object, nullable, required: The frontend of the asset
      - `url` string, required: The url of the asset frontend
      - `type` 'WEBAPP', required: The type of the asset frontend
    - `host` object, nullable, required: The host of the asset
      - `address` string, required: The address of the asset host
      - `type` 'DNS' | 'IPV4' | 'IPV6', required: The type of the asset host
    - `technology` object, nullable, required: Technology metadata for PACKAGE and SOFTWARE assets
      - `type` 'PACKAGE' | 'SOFTWARE', required: Whether this is a PACKAGE or SOFTWARE asset
      - `technologyKey` string, required: Versionless technology identifier (e.g. vendor/product or ecosystem/name)
      - `version` string, nullable, required: Detected version, if known
      - `cpe` string, nullable, required: Common Platform Enumeration identifier, if known
    - `mobileApp` object, nullable, required: Mobile app metadata for APK assets
      - `type` 'APK', required: The type of the mobile app
      - `filename` string, nullable, required: Original uploaded filename
      - `bundleId` string, nullable, required: Android package name, if known
    - `links` object, required: The links of the asset
      - `assetOverview` string, required: The url to view the asset overview in the platform

## Other responses

- `400`: Pagination error

---

[API](https://skmtc.dev/escape/apis/escape-public-api.md) - [All operations](https://skmtc.dev/escape/apis/escape-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/escape/apis/escape-public-api/revisions/2eab35df40c7?raw)
