Audit Reports Search Guide

Latest Update Time: 2026-07-01 00:00:00

Use the audit reports search API to retrieve a paginated list of audit reports for a client account.

See the Audit Introduction for base URL, authentication, and required headers.

Endpoint

GET https://ppapi.qima.com/user/{userId}/audit-reports

Prerequisites

In addition to the required headers and authentication setup:

Permission to view audit reports for the target client

Path Parameters

Parameter	Required	Description
`userId`	Yes	QIMA client user login ID.

Query Parameters

Parameter	Required	Description
`start`	No	Filter start date for the audit date range, in `YYYY-MM-DD` format (e.g., `2016-12-01`).
`end`	No	Filter end date for the audit date range, in `YYYY-MM-DD` format (e.g., `2016-12-01`).
`keyword`	No	Keyword to search against the audit order number or related references.
`page`	No	Page number to show.
`page-size`	No	Page size in search results.
`all`	No	Send `true` to fetch all sub-master account results under a super-master account.
`sortField`	No	Field name to sort by. Should be one of the returned column names.
`sortType`	No	`DESC` or `ASC`.
`startSendDate`	No	Filter start date for the report send/resend date range, in `YYYY-MM-DD` format.
`endSendDate`	No	Filter end date for the report send/resend date range, in `YYYY-MM-DD` format.

Request Example

curl --location --request GET 'https://ppapi.qima.com/user/<qima-user-id>/audit-reports' \
  --header 'Ai-Api-Access-Token: {your api access token}' \
  --header 'Ai-User-Id: {your user ID}' \
  --header 'Authorization: Bearer {your token}' \
  --header 'Referer: https://preprodmy.qima.com/'

This capture does not use any optional query parameters (start, end, keyword, etc.). ⚠️ TODO (Step 2): if useful, add a second example that uses filters.

Successful Response

HTTP 200 OK means the search completed successfully. The response wraps the paginated report list in a generic page structure.

{
    "message": null,
    "content": {
        "pageNo": 1,
        "totalPageNum": 11,
        "totalSize": 214,
        "pageItems": [
            {
                "orderId": "35E6D48021774ED1999C34C78C0543BE",
                "auditDate": "27-Mar-2023",
                "orderNumber": "R-Cloud-PP-23002497",
                "status": "30",
                "auditType": "EA",
                "divisions": "",
                "showDivision": "No",
                "auditProgram": "Big Lots",
                "generalComments": "",
                "serviceType": "9",
                "sicName": "Sam Wang",
                "manDay": "1",
                "isKeyAccount": "No",
                "isReInspection": "YES",
                "clientName": "AuditApp-Automation",
                "dateConfirmed": "Yes",
                "inspectorsNamesList": ["Sam Wang"],
                "numberOfWorkers": "1",
                "factoryName": "FactoryTest40087",
                "factoryId": "17DC5E895B9B46D684A014E078548019",
                "factoryProvince": "Guangdong",
                "countryName": "China",
                "charge": 681.45,
                "supplierName": "SupplierTest64309",
                "supplierProvince": "Zhejiang",
                "supplierCity": "12685402",
                "bookingDate": "2023-03-14",
                "updateTime": "2023-03-14 02:03:47",
                "clientReference": "",
                "orderPlacer": "SP1126",
                "aiOffice": "Shenzhen office",
                "reportCoverOverAllScore": 8.3,
                "riskIndicator": "Green",
                "factoryAddress": "Address test",
                "factoryCity": "Shenzhen",
                "lockStatus": 0,
                "read": false,
                "poNumber": "",
                "validityDate": "2024-03-20",
                "supervisor": "Sam Wang",
                "sendReportTime": 1678775496577,
                "sendReportTimeFormat": "14-Mar-2023 14:31:36"
            },
            {
                "orderId": "36D19E11D53D4B6EBBEC91E13C88CEE0",
                "auditDate": "23-Mar-2023",
                "orderNumber": "R-Cloud-PP-23003511",
                "status": "30",
                "auditType": "EA",
                "divisions": "",
                "showDivision": "No",
                "auditProgram": "Big Lots",
                "generalComments": "",
                "serviceType": "9",
                "sicName": "Sam Wang",
                "manDay": "1",
                "isKeyAccount": "No",
                "isReInspection": "NO",
                "clientName": "AuditApp-Automation",
                "dateConfirmed": "Yes",
                "inspectorsNamesList": ["Sam Wang"],
                "numberOfWorkers": "1",
                "factoryName": "FactoryTest40489",
                "factoryId": "17DC5E895B9B46D684A014E078548019",
                "factoryProvince": "Guangdong",
                "countryName": "China",
                "charge": 681.45,
                "supplierName": "SupplierTest65240",
                "supplierProvince": "Zhejiang",
                "supplierCity": "12685402",
                "bookingDate": "2023-03-20",
                "updateTime": "2023-03-20 11:03:36",
                "clientReference": "EA Internal Ref No 1",
                "orderPlacer": "SP1126",
                "aiOffice": "Nanjing Office",
                "reportCoverOverAllScore": 8.3,
                "riskIndicator": "Green",
                "factoryAddress": "Address test",
                "factoryCity": "Shenzhen",
                "lockStatus": 0,
                "read": false,
                "poNumber": "EA PO No 1",
                "validityDate": "2025-03-16",
                "supervisor": "Sam Wang",
                "sendReportTime": 1679282077987,
                "sendReportTimeFormat": "20-Mar-2023 11:14:37"
            }
        ],
        "countByFields": null
    }
}

The real capture returns 214 items across 11 pages; the array above is trimmed to 2 representative items. A few fields in the raw capture (generalComments, clientReference, poNumber) contained Jira ticket URLs on some records — those look like leftover test data rather than the intended field format, so they were blanked out or replaced with a cleaner record above where available.

Response Field Notes

Field	Notes
`pageNo`	Current page number in the search results.
`totalPageNum`	Total number of pages available for the current query.
`totalSize`	Total number of matching audit reports across all pages.
`pageItems[].orderId`	Internal audit order ID. Pass this as `reportId` to Get Audit Report Details.
`pageItems[].orderNumber`	Client-facing QIMA order number, for example `R-Cloud-PP-23002497`.
`pageItems[].status`	Numeric order status code, for example `30`.
`pageItems[].auditType` / `serviceType`	Text and numeric audit type, for example `EA` / `9` (Ethical Audit).
`pageItems[].riskIndicator`	Risk rating derived from the audit result, for example `Green`.
`pageItems[].reportCoverOverAllScore`	Overall audit score shown on the report cover.
`pageItems[].manDay`	Number of person-days spent on the audit.
`pageItems[].clientReference` / `poNumber`	Client's own reference number / PO number for this order, if provided.
`pageItems[].sendReportTime` / `sendReportTimeFormat`	Unix timestamp (ms) and formatted date/time the report was sent to the client.
`pageItems[].validityDate`	Date the audit report remains valid until, if applicable.
`countByFields`	Aggregate counts, if requested; `null` when not used. Exact grouping is not documented in the OpenAPI schema.

Common Errors

See common authentication errors for 401 and 403 responses.

Next Steps

Use a report ID from the results to retrieve full audit report details.

Documents