---
title: "Search Engagements"
method: POST
path: "/api/vendor/v1/engagements-search"
tags: ["Engagements"]
---

# Search Engagements

`POST /api/vendor/v1/engagements-search`

Use this API to search for engagements associated with a specific vendor by key terms and filters.

## Query parameters

- `page` integer
- `size` integer
- `sort` 'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc'

## Request body

- SearchCriteriaInformation — unresolved $ref

## Response `200`

OK

- PageEngagementListViewInformation
  - `content` EngagementListViewInformation[] — The array of engagement search results.
    - `name` string — The Engagement name.
    - `orgGroupId` string, uuid — The GUID of the Engagement organization.
    - `internalOwnerId` string, uuid — The user ID of the Engagement internal owner.
    - `externalContact` string — The engagement's external contact information.
    - `notes` string — Notes
    - `startDate` string, date-time — Engagement Start Date.
    - `endDate` string, date-time — Engagement End Date.
    - `scope` string — Engagement Scope.
    - `engagementId` string, uuid — The GUID of the Engagement. Can also be found via the engagement details page.
    - `number` integer — This field contains a unique identifier of a particular engagement record.
    - `internalOwnerUser` string — The user full name of the Engagement's Internal owner.
    - `internalOwnerEmail` string, email — The user email of the Engagement's Internal owner.
    - `vendor` Key
      - `id` string, uuid — The vendor identifier in results.
      - `name` string, required — The vendor name in results.
      - `orgGroupId` string, uuid, required — The vendor organization in results.
      - `orgGroupName` string — The vendor organization name in results.
      - `vendorType` InventoryValue
        - `id` string, uuid — The GUID of the Inventory Type.
        - `value` string — The Value of the Inventory Type.
        - `valueKey` string — Translation key used for localizing the value
    - `orgGroupName` string — The engagement's Organization Name.
    - `type` 'VendorEngagement' | 'ProductEngagement' | 'ServiceEngagement' — Engagement Type.
    - `viewOnly` boolean — The parameter to check if the user has view only access or not.
    - `forceAbac` boolean — Parameter to check if the engagement record is according to the org context or not.
    - `workflow` EngagementWorkflowInformation
      - `id` string, uuid — The workflow identifier in results.
      - `nameKey` string — The workflow translation key in results.
      - `name` string — The workflow name in results.
      - `stageId` string, uuid — The workflow stage identifier in results.
      - `stageNameKey` string — The workflow stage key in results.
      - `stageName` string — The workflow stage name in results.
      - `stageBadgeColor` string — The workflow stage color in results.
    - `vendorViewOnly` boolean — Vendor view only access
    - `attributeValues` object — Engagement custom attribute values.
    - `riskLevel` 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' — Engagement's Risk Level.
    - `riskScore` number — Engagement's Risk Score.
    - `inherentRiskLevel` 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' — Engagement's Inherent Risk Level.
    - `inherentRiskScore` number — Engagement's Inherent Risk Score.
    - `targetRiskLevel` 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' — Engagement's Target Risk Level.
    - `targetRiskScore` number — Engagement's Target Risk Score.
    - `engagementStatus` 'ACTIVE' | 'PENDING' | 'ARCHIVED' — Status of Engagement.
    - `lastUpdatedDate` string, date-time — LastUpdatedDate
    - `createdDate` string, date-time — Created Date
    - `createdBy` string, uuid — Created By
    - `createdByUser` string — Engagement created by user name
    - `updatedBy` string, uuid — Updated By
    - `updatedByUser` string — Engagement updated by user name
    - `doraB07010120IdentificationOfAlternativeThirdParty` string — Dora Identification Of Alternative ThirdParty
    - `doraB02020100NoticePeriodFinancialEntity` string — Dora Notice Period Financial Entity
    - `doraB02020110NoticePeriodThirdParty` string — Dora Notice Period ThirdParty
  - `empty` boolean — The flag indicating empty search results.
  - `first` boolean — The flag indicating first page of results.
  - `last` boolean — The flag indicating last page of results.
  - `number` integer — The current page number of results.
  - `numberOfElements` integer — The count of elements in current page.
  - `size` integer — The page size configuration for results.
  - `totalElements` integer — The total count across all pages.
  - `totalPages` integer — The total number of available pages.
  - `redacted` object — Field names that should be redacted when user lacks advanced view access
  - `sort` SortObject
    - `empty` boolean
    - `sorted` boolean
    - `unsorted` boolean
  - `pageable` object — The pagination configuration and metadata.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/revisions/21de3aa0b170/schema)