---
title: "Get List of Initiatives"
method: POST
path: "/v1/initiatives/search"
tags: ["Initiatives"]
---

# Get List of Initiatives

`POST /v1/initiatives/search`

Use this API to retrieve a list of all initiatives or search for initiatives based on the specified criteria.

## Query parameters

- `page` integer — Results page to be retrieved (0..N). Example- '?page=1
- `size` integer — Number of records per page (1..50). Example- '?size=20
- `sort` 'id,asc' | 'id,desc' | 'number,asc' | 'number,desc' | 'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc'

## Request body

- PageSearchRequest
  - `criteria` AttributeQueryCriteria
    - `filters` AttributePredicate[] — The fields and values used to filter results.
      - `field` string, required — The field name used to filter results.
      - `operator` 'EQUAL_TO' | 'NOT_EQUAL_TO' | 'GREATER_THAN' | 'LESS_THAN' | 'BETWEEN' — The relationship that must be met between the field and value.
      - `value` string[] — The field value used to filter results. If filtering for a range of values, this would be the start of the range and should be used in conjunction with the `toValue` parameter.
      - `toValue` string[] — The field value for the end of the range. This field should be used in conjunction with the `value` parameter.
    - `fullText` string — The key terms for the search criteria.

## Response `200`

Initiatives fetched successfully

- InitiativeResponse[]
  - `id` string, uuid — The unique identifier of the initiative.
  - `number` integer — The sequential order in which the initiative was created.
  - `name` string — The name of the initiative.
  - `orgGroupId` string, uuid — The unique identifier of the organization accountable for managing the initiative.
  - `complianceScore` integer — The compliance score of the initiative.
  - `scopeId` string, uuid — The unique identifier of the inventory record associated with the iniatiative.
  - `scopeName` string — The name of the inventory record associated with the initiative.
  - `scopeType` string — The type of inventory record associated with the initiative.
  - `organizationName` string — The name of the organization accountable for managing the initiative.
  - `legislations` LegislationInformation[] — The details of the standards or frameworks associated with the initiative.
    - `name` string — The name of the standard or framework.
    - `frameworkId` string, uuid — The unique identifier of the standard or framework.
    - `otFrameworkIdentifier` string, uuid — The OneTrust system identifier of the standard or framework.
  - `observationStartDT` string, date-time — The start date and time for which the initiative will be observed.
  - `observationEndDT` string, date-time — The end date and time for which the initiative will be observed.
  - `owners` UserInfo[] — The details of the user responsible for the initiative.
    - `id` string, uuid — The unique identifier of the user responsible for the initiative.
    - `active` boolean — This flag indicates whether the user responsible for the initiative is active.
    - `name` string — The name of the user responsible for the initiative.
  - `creationStatus` string — The creation status of the initiative.
  - `inventories` InventoryDetailIdentifier[] — The details of the inventory records associated with the initiative.
    - `id` string, uuid — The unique identifier of the inventory record associated with the iniatiative.
    - `name` string — The name of the inventory record associated with the initiative.
    - `organization` OrgGroupBasicDetailResponse
      - `guid` string, uuid — The unique identifier of the organization responsible for the inventory record.
      - `name` string — The name of the organization responsible for the inventory record.
      - `languageId` integer — The ID of the default language for the organization responsible for the inventory record.
    - `inventoryType` string — The type of inventory record associated with the initiative.
    - `number` integer — The sequential number of the inventory record associated with the initiative.
  - `workflowAndStage` EntityWorkflowInformation
    - `id` string, uuid, required — The unique identifier of the workflow.
    - `name` string, required — The name of the workflow.
    - `type` string, required — The type of workflow.
    - `workflowMode` 'ADVANCED, BASIC' — This parameter indicates whether the workflow mode is null, basic, or advanced.
    - `stageId` string, uuid, required — The unique identifier of the workflow stage.
    - `stageName` string, required — The name of the workflow stage.
  - `auditFields` EntityRecordAuditInformation
    - `createdDate` string, date-time, required — The date and time that the entity was last created.
    - `lastUpdatedDate` string, date-time — The date and time that the entity was last updated.
    - `createdBy` EntityBasicUserInformation
      - `id` string, uuid — The unique identifier of the user.
      - `name` string — The full name of the user.
      - `email` string — The email address of the user.
      - `initials` string — The initials for the first and last name of the user.
    - `lastModifiedBy` EntityBasicUserInformation
      - `id` string, uuid — The unique identifier of the user.
      - `name` string — The full name of the user.
      - `email` string — The email address of the user.
      - `initials` string — The initials for the first and last name of the user.

## Other responses

- `400` — Unsupported filter field
- `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)