Skip to main content
GET
/
api
/
public
/
v1
/
compliance
/
checks
List assigned compliance checks
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/compliance/checks \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "checkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "description": "<string>",
      "status": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "color": "<string>",
        "isPositive": true,
        "isComplete": true
      },
      "priority": "High",
      "criticality": 5,
      "flagged": true,
      "dueDate": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "notesPublic": "<string>",
      "notesPrivate": "<string>",
      "runId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "runName": "<string>",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyName": "<string>",
      "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "groupName": "<string>",
      "deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deviceName": "<string>",
      "locationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "locationName": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
page
number
default:1

Page number

Required range: x >= 1
​
limit
number
default:20

Items per page

Required range: 1 <= x <= 100
​
orderBy
enum<string>
default:updated_at

Field to order by

Available options:
updated_at,
due_date,
priority,
created_at
​
orderDirection
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
runId
string<uuid>

Filter by compliance run ID

​
companyId
string<uuid>

Filter by company ID

​
status
string

Filter by status name (e.g., 'Pass', 'Fail', 'Pending')

​
priority
enum<string>

Filter by priority

Available options:
High,
Medium,
Low
​
flagged
boolean

Filter by flagged status

​
overdue
boolean

Filter to show only overdue checks

​
search
string

Search by check title

Maximum string length: 100

Response

List of assigned compliance checks

​
data
object[]
required

Array of assigned checks

​
pagination
object
required