---
title: "POST /api/GetDocumentsByStatus"
method: POST
path: "/api/GetDocumentsByStatus"
tags: ["Dashboard"]
---

# POST /api/GetDocumentsByStatus

`POST /api/GetDocumentsByStatus`

## Headers

- `Authorization` string, required
- `UserName` string

## Request body

- EmsignerAPIBusinessObjectWorkflowSearchDTO
  - `TabStatusType` string
  - `Status` string — Status of the workflow(eg. Pending ,Completed)
  - `pagenumber` integer — Used for pagination
  - `PageSize` integer — Used for pagination
  - `SelectedYear` string
  - `DocName` string — DocumentName
  - `DocOwner` string — Originator of the workflow
  - `StartDate` string — Start Date( in yyyy-mm-dd format(2020-06-04))
  - `EndDate` string — End Date ( in yyyy-mm-dd format(2020-06-04))
  - `LastSignedBy` string
  - `CompletedDate` string
  - `CompletedEndDate` string
  - `DeclinedBy` string
  - `DeclinedDate` string — DeclinedDate ( in yyyy-mm-dd format(2020-06-04))
  - `DeclineEnddDate` string
  - `RecalledDate` string — RecalledDate ( in yyyy-mm-dd format(2020-06-04))
  - `RecalledEndDate` string
  - `InactiveDate` string
  - `InactiveEndDate` string
  - `ExpiryFromDate` string — Document expiry start date ( in yyyy-mm-dd format(2020-06-04))
  - `ExpiryToDate` string — Document expiry end date ( in yyyy-mm-dd format(2020-06-04))
  - `PurgedDate` string
  - `VoidedDate` string
  - `TemplateName` string — TemplateName of the workflow
  - `SendImageUrl` boolean
  - `CategoryName` string — CategoryName
  - `DocumentNumber` string — DocumentNumber
  - `Referenceno` string — Referenceno
  - `SignedDate` string — SignedDate ( in yyyy-mm-dd format(2020-06-04))
  - `Customstatus` string — Customstatus
  - `IsSearch` boolean
  - `DonotRequireFlexiform` boolean

## Response `200`

OK

- EMDMSHelperReturnObjectSystemCollectionsGenericListEmsignerAPIBusinessObjectDashBoardViewModel
  - `IsSuccess` boolean
  - `Messages` string[]
  - `ErrorCode` integer
  - `Response` EmsignerAPIBusinessObjectDashBoardViewModel[]
    - `WorkFlowId` integer
    - `InitaitedBy` string
    - `UploadTime` string
    - `DisplayName` string
    - `DocumentId` integer
    - `LastSignedOn` string
    - `LastSignedBy` string
    - `DeclinedOn` string
    - `DeclinedBy` string
    - `Remarks` string
    - `RecalledOn` string
    - `VoidedOn` string
    - `PurgedOn` string
    - `InactivedOn` string
    - `Status` string
    - `ThumbnailBase64` string
    - `ReferenceNo` string
    - `EnvelopNo` string
    - `Category` string
    - `Noofdocuments` integer
    - `NoofAttachments` integer
    - `Documents` string
    - `NoOfComments` integer
    - `OriginatorId` integer
    - `TemplateId` integer
    - `WorkflowType` integer

---

[API](https://skmtc.dev/emsigner/apis/emsignerapi.md) · [All operations](https://skmtc.dev/emsigner/apis/emsignerapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/emsigner/emsignerapi/revisions/7d5d55e0d91d/schema)