---
title: "Get Workpaper Control Details"
method: GET
path: "/api/audit-management/v1/audit-workpapers/{workpaperId}/control-details"
tags: ["Workpapers"]
---

# Get Workpaper Control Details

`GET /api/audit-management/v1/audit-workpapers/{workpaperId}/control-details`

## Request

- Base URL: `https://hostname`
- URL: `https://hostname/api/audit-management/v1/audit-workpapers/{workpaperId}/control-details`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://{hostname}/api/access/v1/oauth/token` scopes: `AUDIT_MANAGEMENT`

Use this API to retrieve the control details of a specific workpaper.

> Note: Things to Know
> 
> - Workpaper attributes can be retrieved using the [Get Workpaper Results](https://developer.onetrust.com/onetrust/reference/getworkpaperresultusingget) API.

## Path parameters

- `workpaperId` string, uuid, required

## Response `200`

OK

- ControlWorkpaperBasicInformation
  - `workpaperId` string, uuid: Workpaper identifier
  - `number` integer: Workpaper Number
  - `auditId` string, uuid: Audit Identifier
  - `auditName` string: Audit Name
  - `stage` BasicEntityDetailTranslation
    - `id` string, uuid, required: ID of the entity
    - `name` string: Name of the Entity
    - `nameKey` string: Namekey of the entity for localization
  - `workflow` BasicEntityDetailTranslation
    - `id` string, uuid, required: ID of the entity
    - `name` string: Name of the Entity
    - `nameKey` string: Namekey of the entity for localization
  - `controlDetail` ControlDetailInformation
    - `id` string, uuid, required: The identifier of the control.
    - `identifier` string, required: The identifier of the control.
    - `name` string, required: The name of the control.
    - `description` string: Description of the control.
    - `orgGroupId` string, uuid, required: The identifier of the organization the master control is linked to. In general, this is the top organization in the organization hierarchy.
    - `orgGroupName` string, required: Organization Group Name of Control.
    - `frameworkId` string, uuid: Identifier (GUID) of the framework on the control.
    - `frameworkName` string: Framework Name of Control.
    - `frameworkNameKey` string: Framework Name key for Translation.
    - `categoryId` string, uuid: Identifier (GUID) of the category on the control.
    - `categoryName` string: Name of the category on the control.
    - `categoryNameKey` string: Identifier used for translation of Category Name.
    - `seedControlId` string, uuid: The identifier of control that was seeded to the Master Control.
    - `otControlIdentifier` string, uuid: Unique OT identifier of Control.
    - `status` 'Active' | 'Archived' | 'Pending': The new status of the control. This can be Active, Archived, or Pending.
    - `attributes` object: Custom attributes for the control. These attributes are custom to the tenant.
    - `implementationGuidance` string: Implementation guidance of the control requirement.
    - `licensedContentMissing` boolean: Flag which identify if any licensed content is missing and should obtain the license validation to view all content.
    - `contentVersion` string: Indicates the content version of this record.

## 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.dev/onetrust/apis/tech-risk-compliance-audit-management.md) - [All operations](https://skmtc.dev/onetrust/apis/tech-risk-compliance-audit-management/llms.txt) - [OpenAPI document](https://skmtc.dev/onetrust/apis/tech-risk-compliance-audit-management/revisions/b01323a55e99?raw)