---
title: "Get Initiative"
method: GET
path: "/v1/initiatives/{initiativeId}"
tags: ["Initiatives"]
---

# Get Initiative

`GET /v1/initiatives/{initiativeId}`

## Request

- Base URL: `https://hostname/api/compliance-wr`
- URL: `https://hostname/api/compliance-wr/v1/initiatives/{initiativeId}`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `COMPLIANCE_AUTOMATION_READ`

Use this API to retrieve details for a specific initiative. The response will include details such as the created date, workflow, and stage.

## Path parameters

- `initiativeId` string, uuid, required

## Response `200`

Initiative details 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': The mode in which the workflow was created.
    - `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 initiative was created.
    - `lastUpdatedDate` string, date-time: The date and time that the initiative was last updated.
    - `createdBy` EntityBasicUserInformation
      - `id` string, uuid: The unique identifier of the user who last modified the initiative.
      - `name` string: The name of the user who last modified the initiative.
      - `email` string: The email address of the user who last modified the initiative.
      - `initials` string: The initials of the user who last modified the initiative.
    - `lastModifiedBy` EntityBasicUserInformation
      - `id` string, uuid: The unique identifier of the user who last modified the initiative.
      - `name` string: The name of the user who last modified the initiative.
      - `email` string: The email address of the user who last modified the initiative.
      - `initials` string: The initials of the user who last modified the initiative.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Initiative not found.
- `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.dev/onetrust/apis/tech-risk-compliance-compliance-automation.md) - [All operations](https://skmtc.dev/onetrust/apis/tech-risk-compliance-compliance-automation/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/tech-risk-compliance-compliance-automation/revisions/da7f7c5f2c27?raw)