---
title: "Get all clarification details of the given workflow."
method: POST
path: "/api/Reports/clarification"
tags: ["Reports"]
---

# Get all clarification details of the given workflow.

`POST /api/Reports/clarification`

## Request

- Base URL: `https://apidocs.cflowapps.com` (the document declares no server; this is the origin it was published from)
- URL: `https://apidocs.cflowapps.com/api/Reports/clarification`
- Auth: API key in header `X-Api-Key` and API key in header `X-User-Key`
- TypeScript: <https://skmtc.dev/cflowapps/apis/cflow-public-api/docs/api/Reports/clarification/post.ts> (a function with typed inputs; its response is checked against the schema)

Sample Request

         POST
         {
           "WorkflowName": "Test Workflow",
           "StageName" : "Initiator",        // 'All' for all stage.
           "StartDate": "03/01/2024",       
           "EndDate": "03/25/2024",         
           "ClarifyFrom": "12testing.com",   // 'All' for all users
           "ClarifyTo": "Echo",              // 'All' for all users
           "ClarifyDate": "02/10/2024"

## Request body

- ClarifyReportRequest
  - `workflowName` string, required: Name of the worklfow
  - `stageName` string, required: Name of the stage
  - `startDate` string, required: Date From (MM/dd/yyyy)
  - `endDate` string, required: Date To (MM/dd/yyyy)
  - `clarifyFrom` string, required: Username from whom clarification is requested
  - `clarifyTo` string, required: Username to whom clarification is requested
  - `clarifyDate` string, required: Clarification Date

## Response `200`

List of clarifications data.

- ClarifyRptDto[]
  - `stageName` string, nullable: Name of the workflow stage where clarification was raised.
  - `recordId` integer: Unique identifier of the record.
  - `clarificationRequestedFrom` string, nullable: User who requested the clarification.
  - `clarificationRequestedTo` string[], nullable: User to whom the clarification was sent.
  - `clarificationRequest` string, nullable: Clarification question or request details.
  - `clarificationResponse` string, nullable: Response provided for the clarification request.
  - `sentDate` string, nullable: Date when the clarification was requested.
  - `responseDate` string, nullable: Date when the clarification response was provided.
  - `recalled` string, nullable: Indicates whether the clarification request was recalled
  - `recalledDate` string, nullable: Date when the clarification was recalled, if applicable.

## Other responses

- `400`: Bad request
- `401`: If you don't have access to the report, you cannot get the report data.
- `403`: Forbidden
- `404`: No clarfification details found for the given workflow
- `500`: Internal Server Error

---

[API](https://skmtc.dev/cflowapps/apis/cflow-public-api.md) - [All operations](https://skmtc.dev/cflowapps/apis/cflow-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cflowapps/apis/cflow-public-api/revisions/af0dadd0ad10?raw)