# Nudge Security Public API Documentation

> Documentation for Nudge Security Public API

## API Reference: Nudge API
- Apps
  - [Set the app category of an app](https://nudgesecurity.readme.io/reference/post_api-1-0-apps-app-category-app-id.md)
  - [Search apps](https://nudgesecurity.readme.io/reference/post_api-1-0-apps-search.md)
  - [Bulk update apps](https://nudgesecurity.readme.io/reference/post_api-1-0-apps-bulk.md): Update multiple properties in bulk for a list of apps.
  - [Search apps by supply chain](https://nudgesecurity.readme.io/reference/post_api-1-0-apps-search-supply-chain.md)
  - [Get an app](https://nudgesecurity.readme.io/reference/get_api-1-0-apps-app-id.md)
  - [Delete a field from an app](https://nudgesecurity.readme.io/reference/delete_api-1-0-apps-app-id-fields-field-id.md)
  - [Add a field to an app](https://nudgesecurity.readme.io/reference/post_api-1-0-apps-app-id-fields-field-id.md)
  - [Delete a label from an app](https://nudgesecurity.readme.io/reference/delete_api-1-0-apps-app-id-labels.md)
  - [Search app instances](https://nudgesecurity.readme.io/reference/post_api-1-0-apps-app-id-instances-search.md)
  - [Add a label to an app](https://nudgesecurity.readme.io/reference/post_api-1-0-apps-app-id-labels.md)
  - [Remove the technical contact of an app](https://nudgesecurity.readme.io/reference/delete_api-1-0-apps-app-id-technical-contact.md)
  - [Update the technical contact of an app](https://nudgesecurity.readme.io/reference/post_api-1-0-apps-app-id-technical-contact-user-id.md)
- Accounts
  - [Search accounts](https://nudgesecurity.readme.io/reference/post_api-1-0-accounts-search.md)
  - [Get an account](https://nudgesecurity.readme.io/reference/get_api-1-0-accounts-account-id.md)
  - [Delete a field from an account](https://nudgesecurity.readme.io/reference/delete_api-1-0-accounts-account-id-fields-field-id.md)
  - [Add a field to an account](https://nudgesecurity.readme.io/reference/post_api-1-0-accounts-account-id-fields-field-id.md)
  - [Delete a label from an account](https://nudgesecurity.readme.io/reference/delete_api-1-0-accounts-account-id-labels.md)
  - [Add a label to an account](https://nudgesecurity.readme.io/reference/post_api-1-0-accounts-account-id-labels.md)
- Oauth Grants
  - [Search oauth grants](https://nudgesecurity.readme.io/reference/post_api-1-0-oauth-grants-search.md)
  - [Get an oauth grant](https://nudgesecurity.readme.io/reference/get_api-1-0-oauth-grants-oauth-id.md)
- Events
  - [Search events](https://nudgesecurity.readme.io/reference/post_api-1-0-events-search.md)
  - [Get an event](https://nudgesecurity.readme.io/reference/get_api-1-0-events-event-id.md)
- Users
  - [Search users](https://nudgesecurity.readme.io/reference/post_api-1-0-users-search.md)
  - [Get a user](https://nudgesecurity.readme.io/reference/get_api-1-0-users-user-id.md)
- User Groups
  - [Search groups](https://nudgesecurity.readme.io/reference/post_api-1-0-groups-search.md)
  - [Get a group](https://nudgesecurity.readme.io/reference/get_api-1-0-groups-group-id.md)
  - [Search group members](https://nudgesecurity.readme.io/reference/post_api-1-0-groups-group-id-members-search.md)
- Notifications
  - [Search notifications](https://nudgesecurity.readme.io/reference/post_api-1-0-notifications-search.md)
  - [Get a notification](https://nudgesecurity.readme.io/reference/get_api-1-0-notifications-notification-id.md)
- Fields
  - [Create a field](https://nudgesecurity.readme.io/reference/post_api-1-0-fields.md)
  - [Search fields](https://nudgesecurity.readme.io/reference/post_api-1-0-fields-search.md)
  - [Delete a field](https://nudgesecurity.readme.io/reference/delete_api-1-0-fields-field-id.md)
  - [Get a field](https://nudgesecurity.readme.io/reference/get_api-1-0-fields-field-id.md)
  - [Update a field](https://nudgesecurity.readme.io/reference/put_api-1-0-fields-field-id.md)
  - [Delete an allowed value of a field](https://nudgesecurity.readme.io/reference/delete_api-1-0-fields-field-id-allowed-values.md)
  - [Add an allowed value to a field](https://nudgesecurity.readme.io/reference/post_api-1-0-fields-field-id-allowed-values.md)
  - [Update an allowed value of a field](https://nudgesecurity.readme.io/reference/put_api-1-0-fields-field-id-allowed-values.md)
- Labels
  - [Delete a label](https://nudgesecurity.readme.io/reference/delete_api-1-0-labels.md)
  - [Create a label](https://nudgesecurity.readme.io/reference/post_api-1-0-labels.md)
  - [Update a label](https://nudgesecurity.readme.io/reference/put_api-1-0-labels.md)
  - [Search labels](https://nudgesecurity.readme.io/reference/post_api-1-0-labels-search.md)
- Findings
  - [Search findings](https://nudgesecurity.readme.io/reference/post_api-1-0-findings-search.md)
  - [Get a finding](https://nudgesecurity.readme.io/reference/get_api-1-0-findings-finding-id.md)
- Playbooks
  - [Start offboarding of an user](https://nudgesecurity.readme.io/reference/post_api-1-0-playbooks-offboarding.md)
- App-To-App Integrations
  - [Search other app-to-app integrations](https://nudgesecurity.readme.io/reference/post_api-1-0-app-to-app-integrations-other-search.md)
  - [Get an app-to-app integration](https://nudgesecurity.readme.io/reference/get_api-1-0-app-to-app-integrations-auth-method-id.md)
- App Instances
  - [Search app instances](https://nudgesecurity.readme.io/reference/post_api-1-0-instances-search.md)
  - [Get an app instance](https://nudgesecurity.readme.io/reference/get_api-1-0-instances-instance-id.md)
- Ai Sessions
  - [Search AI sessions](https://nudgesecurity.readme.io/reference/post_api-1-0-ai-sessions-search.md): Args: page_request: Paginated request with mandatory start_date and end_date filters, optional additional filters/sorting  Returns: Paginated list of AI sessions
  - [Get AI session details](https://nudgesecurity.readme.io/reference/get_api-1-0-ai-sessions-ai-session-timestamp-ai-session-identifier.md): Args: ai_session_timestamp: Timestamp identifying the AI session start date (e.g. 1776369954940000) ai_session_identifier: Unique identifier of the AI session (e.g.…
- Ai Prompts
  - [Search AI prompts](https://nudgesecurity.readme.io/reference/post_api-1-0-ai-prompts-search.md): Args: page_request: Paginated request with mandatory start_date and end_date filters, optional additional filters/sorting  Returns: Paginated list of AI prompts
- Browser Extension
  - [Search Browser Extension Clients](https://nudgesecurity.readme.io/reference/post_api-1-0-browser-extension-clients-search.md): Search Browser Extension Clients with pagination and filtering.  A Browser Extension Client identifies the Nudge extension installation in a specific browser.
  - [Search Browser Extension Records](https://nudgesecurity.readme.io/reference/post_api-1-0-browser-extension-records-search.md): Search Browser Extension Records with pagination and filtering.  The Browser Extension Records contain the inventory of extensions installed in the browsers where the Nudge extension is running.
  - [Get information about the available browser extension insights](https://nudgesecurity.readme.io/reference/get_api-1-0-browser-extension-insights.md)
  - [Get the latest agent analysis for a browser extension](https://nudgesecurity.readme.io/reference/get_api-1-0-browser-extension-extension-id-agent-analysis.md)
  - [Get the agent analysis for a browser extension version](https://nudgesecurity.readme.io/reference/get_api-1-0-browser-extension-extension-id-versions-version-id-agent-analysis.md)
- Ai Agents
  - [Search AI agents](https://nudgesecurity.readme.io/reference/post_api-1-0-ai-agents-search.md): Args: page_request: Paginated request with optional filters/sorting  Returns: Paginated list of AI agents
- Tprm
  - [Search the security and risk data of apps](https://nudgesecurity.readme.io/reference/post_api-1-0-tprm-apps-search.md): Paginated export of the App Security and App Risk data. Supports filtering and sorting by inherent and residual risk score, and incremental pulls through `changed_since`.
  - [Get the security and risk data of an app](https://nudgesecurity.readme.io/reference/get_api-1-0-tprm-apps-app-id.md): Returns the App Security and App Risk data of an app: compliance certifications, security links, authentication methods, supply chain, inherent and residual risk scores with risk levels, business…
  - [Search the breaches affecting the apps](https://nudgesecurity.readme.io/reference/post_api-1-0-tprm-breaches-search.md): Paginated list of the breaches affecting the organization apps, either directly (the app vendor) or through one of its sub-processors, newest breach first. Supports filtering by breach date, seen…