---
title: "JSON Schema for every v1 response"
method: GET
path: "/api/v1/schema"
---

# JSON Schema for every v1 response

`GET /api/v1/schema`

## Request

- Base URL: `https://crawlcheck.io`
- URL: `https://crawlcheck.io/api/v1/schema`
- Auth: none required

## Response `200`

JSON Schema 2020-12

- object, nullable
  - `$schema` string, nullable
  - `$id` string, nullable
  - `title` string, nullable
  - `description` unknown
  - `$defs` object, nullable
    - `PublicReportV1` object, nullable
      - `type` string, nullable
      - `additionalProperties` boolean, nullable
      - `required` string[], nullable
      - `properties` object, nullable
        - `schema` object, nullable
          - `type` string, nullable
        - `version` object, nullable
          - `const` string, nullable
        - `id` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `domain` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `path` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `scanned_host` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `scanned_at` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `score_version` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `grade` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `overall` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `grade_detail` object, nullable
          - `type` string, nullable
          - `properties` object, nullable
        - `sections` object, nullable
          - `type` string, nullable
          - `items` object, nullable
        - `findings` object, nullable
          - `type` string, nullable
          - `items` object, nullable
        - `findings_withheld` object, nullable
          - `type` unknown[], nullable
            - unknown
          - `description` string, nullable
        - `findings_summary` object, nullable
          - `type` unknown[], nullable
            - unknown
          - `properties` object, nullable
        - `provenance` object, nullable
          - `type` unknown[], nullable
            - unknown
          - `description` string, nullable
        - `checks` object, nullable
          - `type` string, nullable
          - `items` object, nullable
        - `agentview` object, nullable
          - `type` string, nullable
          - `items` object, nullable
        - `nap` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `headroom` object, nullable
          - `type` unknown[], nullable
            - unknown
          - `properties` object, nullable
        - `history` object, nullable
          - `type` string, nullable
          - `items` object, nullable
        - `proof` object, nullable
          - `type` string, nullable
          - `properties` object, nullable
        - `links` object, nullable
          - `type` string, nullable
    - `MachineRecordV1` object, nullable
      - `type` string, nullable
      - `required` string[], nullable
      - `description` unknown
      - `properties` object, nullable
        - `kind` object, nullable
          - `const` string, nullable
        - `version` object, nullable
          - `type` string, nullable
        - `subject` object, nullable
          - `type` string, nullable
        - `observation` object, nullable
          - `type` string, nullable
        - `findings` object, nullable
          - `type` string, nullable
          - `description` string, nullable
        - `freshness` object, nullable
          - `type` string, nullable
          - `description` string, nullable
        - `confidence` object, nullable
          - `type` string, nullable
          - `description` string, nullable
        - `contradictions` object, nullable
          - `type` string, nullable
          - `description` string, nullable
        - `findings_summary` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `findings_withheld` object, nullable
          - `type` unknown[], nullable
            - unknown
        - `capabilities` object, nullable
          - `type` string, nullable
        - `evidence` object, nullable
          - `type` string, nullable
        - `access` object, nullable
          - `type` string, nullable
    - `ErrorV1` object, nullable
      - `type` string, nullable
      - `required` string[], nullable
      - `properties` object, nullable
        - `error` object, nullable
          - `type` string, nullable
          - `required` unknown[], nullable
            - unknown
          - `properties` object, nullable

---

[API](https://skmtc.dev/crawlcheck/apis/crawlcheck-api.md) · [All operations](https://skmtc.dev/crawlcheck/apis/crawlcheck-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlcheck/apis/crawlcheck-api/revisions/57acbd6d4489?raw)