Skip to content
API reference/
/
List audits

List audits

Request

Return the company's audits, one page at a time, newest audit period first.

Each row is an audit engagement: the framework being audited (id and name), its lifecycle status (active, not_active or completed), the audit period and timestamps. Every audit is listed, whatever its status - narrow with status to answer "what is our current audit". Filters combine with AND.

pagination.total is every audit that matched, across all pages. A null pagination.nextCursor means there are no more results.

Security
BearerAuth
Query
statusAuditStatus (string) or null(Status)
Any of:

Where an audit is in its lifecycle. Stored by the product; served as snake_case.

string(AuditStatus)
Enum:"active""not_active""completed"
frameworkIdstring or null(Frameworkid)
Any of:

Only audits of this framework (its id).

string
sortstring(Sort)

Field to order the results by. Audits with no value for it come last when descending.

Default:"startDate"
Enum:"startDate""endDate""createdAt""updatedAt"
descendingboolean(Descending)

Newest first (the default); false for oldest first.

Default:true
cursorstring or null(Cursor)
Any of:

Cursor from a previous page's pagination.nextCursor.

non-empty
string
limitinteger, [ 1 .. 100 ](Limit)

Results per page (1-100).

Default:50
curl -i -X GET \
  'https://developers.scytale.ai/_mock/openapi/v1/audits?status=active&frameworkId=string&sort=startDate&descending=true&cursor=string&limit=50' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful Response

Bodyapplication/json
dataArray of objects(Audit)required

This page of results.

paginationobject(PageInfo)required

How to fetch the next page, and how much there is.

Response
{
  "data": [
    { … }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "string",
    "limit": 0,
    "total": 0
  }
}