---
title: "This resource returns a collection of `TOE` objects mapped to a customer."
method: GET
path: "/v1/toes_paginated"
tags: ["Target Of Evaluation TOE"]
---

# This resource returns a collection of `TOE` objects mapped to a customer.

`GET /v1/toes_paginated`

This API retrieves a collection of TOE objects mapped to a customer.
This include overall ratings and some domain rating information for the current analysis of the provided TOE id.
As a TOE can have multiple internal IDs, this API filters if the internal ID is one among the multiple internal IDs.

## Query parameters

- `internal_id[]` string[]
- `last_retrieved` string
- `page` integer
- `per_page` integer
- `risk_dimensions[]` string[]
- `sort_method` 'ASC' | 'DESC'
- `toe_id` string
- `sort_attribute` 'toe_short_name' | 'date_updated'

## Response `200`

OK

- PaginatedToes
  - `meta` PaginationMeta
    - `current_page` integer — The current page of paginated responses.
    - `next_page` integer, nullable — The next page of paginated responses if applicable.
    - `prev_page` integer, nullable — The previous page of paginated responses if applicable.
    - `total_count` integer — The total count of items.
    - `total_pages` integer — The total number of pages for paginated responses.
  - `data` object[] — Data associated with response object.
    - `attributes` PaginatedToe
      - `toe_short_name` string, required — The Company or entity name.
      - `toe_id` string, uuid, required — The unique identifier for the Target Of Evaluation (TOE).
      - `ticker_symbols` object[], required — A collection of TickerSymbols
        - `ticker_symbol` string — A ticker symbol associated with the TOE if available.
        - `exchange_name` string — The exchange the ticker symbol is associated with.
      - `analysis_id` string, required — The unique identifier for analysis.
      - `date_updated` string, required — The date a data loss event was updated.
      - `seed_hostnames` string[], required — The seed hostnames are the hostnames used to start the scan. This doesn't include all hostnames from the scan results
      - `risk_configurations` object[], required — A collection of RiskConfigurations.
        - `risk_relationship` string — The Custom Category for a TOE in the current customers portfolio.
        - `inherent_risk` string — A Risk Rating Scheme associated with TOE in current customers portfolio.
      - `internal_name` string[], nullable, required — The user defined names for the TOE.
      - `internal_id` string[], nullable, required — The user defined identifiers for the TOE. These can be used to query the TOE.
      - `duns_numbers` string[], required — The DUNS number for the TOE. This may or may not be populated.
      - `frequency` string, required — Is this TOE setup for a one_time or continuous scan?
      - `subscription_level` string, required — The subscription level for the TOE.
      - `privacy_subscription_level` string, nullable — The privacy subscription level for the TOE.
      - `cyber_rating` string, nullable, required — The rating label of an analysis or of some domain or criteria of the analysis.
      - `cyber_rating_numeric` number, nullable, required — The numeric rating of an analysis or of some domain or criteria of the analysis.
      - `privacy_rating` string, nullable — The rating label of an analysis or of some domain or criteria of the analysis.
      - `privacy_rating_numeric` number, nullable — The numeric rating of an analysis or of some domain or criteria of the analysis.
      - `security_domain_ratings` object[], required — array of security_domain_ratings
        - `security_domain` string — The security_domain category rating
        - `rating` string, nullable — The rating label of an analysis or of some domain or criteria of the analysis.
        - `rating_numeric` number, nullable — The numeric rating of an analysis or of some domain or criteria of the analysis.
        - `risk_dimension` string — Category of security domain or criteria. Can currently be cyber or privacy.
        - `display_name` string, nullable — The display name seen on RiskRecon portal site.
        - `rated` boolean, nullable — Is this domain or criteria rated?
    - `id` string — The identifier associated with response object.
    - `type` string — The type of object returned.

## Other responses

- `400` — Something was wrong with the request
- `401` — Authentication information was missing or invalid or the user is not authorized to access resource or perform the associated action.
- `403` — FORBIDDEN

---

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