Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Issues

Get List of Issues

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

post/v1/issues/search

Query parameters

pageinteger

Results page to be retrieved (0..N). Example- '?page=1

The page number of the results.

sizeinteger

Number of records per page (1..50). Example- '?size=20

The number of results per page.

sort'Id,asc' | 'Id,desc' | 'Name,asc' | 'Name,desc' | 'createdDate,asc' | 'createdDate,desc' | 'Priority,asc' | 'Priority,desc' | 'deadline,asc' | 'deadline,desc'

The sort criteria that dictates the order of the results.

Request body

Response

Issues fetched successfully

idstring uuid

The unique identifier of the issue.

numberinteger

The page number of the results.

namestring

The name that describes the issue.

orgGroupIdstring uuid

The unique identifier of the organization associated with the issue.

descriptionstring

The description of the issue.

deadlinestring date

The date by which the issue should be resolved.

ownerIdsstring[]

The unique identifiers of the issue owners who will remediate the issue.

approverIdsstring[]

The unique identifier(s) of the users assigned as approvers of the issue.

reasonForClosurestring

The reason why the issue was closed.

categorystring

The category of the issue.

status'Open' | 'Closed'

The status of the issue.

sourceType'Control' | 'Evidence' | 'Initiative' | 'Issue' | 'Risk' | 'assessment' | 'assets' | 'entities' | 'policies' | 'procedures' | 'processing-activities' | 'standards' | 'vendors'

The entity type of the source record.

sourceIdstring uuid

The unique identifier of the source record.

notestring

The notes related to resolving the issue.

actionPlanstring

The remediation plan for the issue.

closedBystring uuid

The unique identifier of the user who closed the issue.

closedDatestring

The date when the issue is closed.

createdBystring uuid

The unique identifier of the user who created the issue.

createdDatestring date

The date when the issue is created.

attributesobject

The details of the associated attributes.

Example response

[
  {
    "id": "ab129a431-3d3d-4352-9daf-71f6ea2b3d70",
    "number": 1,
    "name": "Expired Policies",
    "orgGroupId": "cb49a431-3d3d-4352-9daf-71f6ea2b3d89",
    "description": "System would be at risk if we do not renew access policies",
    "deadline": "2021-12-31",
    "reasonForClosure": "Resolved",
    "category": "General",
    "status": "Open",
    "sourceType": "Risk",
    "sourceId": "ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86",
    "note": "Closed the issue as its been resolved",
    "actionPlan": "1. Disabled user's unauthorized access.\n 2. Informed relevant teams.",
    "closedBy": "ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86",
    "closedDate": "2025-05-07T14:42:32.950Z",
    "createdBy": "ad49a0f1-3d3d-4352-9daf-71f6ea2b2c86",
    "createdDate": "2021-12-31",
    "workflowAndStage": {
      "id": "b271c01a-89a9-41b1-8185-0a3e2bfdad84",
      "name": "Vendor On-Boarding Workflow",
      "type": "Vendor",
      "workflowMode": "BASIC",
      "stageId": "9fc111cb-c379-4f08-8aff-5be954c1a6e6",
      "stageName": "Start On-Boarding"
    },
    "auditFields": {
      "createdBy": {
        "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
        "name": "Name"
      },
      "lastModifiedBy": {
        "id": "c21319953-b4b5-4042-8cb9-b78038cc4c51",
        "name": "Name"
      }
    },
    "attributes": {
      "textAttributeName": [
        {
          "value": "Text"
        }
      ],
      "optionBasedAttributeName": [
        {
          "id": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
        }
      ]
    }
  }
]