Skip to main content
GET
/
api
/
public
/
v1
/
compliance
/
runs
/
{id}
Get compliance run
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/compliance/runs/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyName": "<string>",
    "runDate": "2023-11-07T05:31:56Z",
    "isCompleted": true,
    "notes": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "totalChecks": 123,
    "passedChecks": 123,
    "failedChecks": 123,
    "pendingChecks": 123
  },
  "assignedChecks": [
    {
      "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"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Compliance run ID

Response

Compliance run with assigned checks

data
object
required
assignedChecks
object[]
required

Assigned checks for this run