# Spotlight API

The **Spotlight API** provides endpoints designed to highlight key platform objects that may need attention. These objects can include agreements, orders, subscriptions, invoices, and more.

The API consists of two primary endpoints: `spotlightObject` and `spotlightQuery`. With this API, you can:

* List all spotlighted objects.
* Invalidate or clear the cache for Spotlight objects.
* List the defined spotlight queries.
* Get details for a specific spotlight query.
* Update an existing spotlight query.

## Core Concepts

The Spotlight API is built around the following core resources:

* **SpotlightObject** - Represents a collection of spotlighted objects.
* **SpotlightTopItem** - Represents individual top result items identified by `spotlightQuery`.
* **SpotlightQuery** - Represents the search query used to retrieve spotlighted data.

## Collection

The API is organized into a single collection, containing a set of operations. Access to these operations varies by role, depending on whether you are a `client`, `vendor`, or `operations` user. 

Refer to the following capability matrix to see which roles are authorized to perform specific operations within this collection:

<table><thead><tr><th width="297">Capability</th><th width="152">Client</th><th width="130">Vendor</th><th>Operations</th></tr></thead><tbody><tr><td>List spotlighted objects</td><td>✅</td><td>✅</td><td>✅</td></tr><tr><td>Invalidate a specific spotlight object</td><td>✅</td><td>✅</td><td>✅</td></tr><tr><td>Invalidates all cache objects</td><td>✅</td><td>✅</td><td>✅</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.platform.softwareone.com/developer-resources/rest-api/spotlight-objects-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.