---
title: "The document family that governs a subject in a market, and who publishes it"
method: GET
path: "/documents"
tags: ["Diagnoses and documents"]
---

# The document family that governs a subject in a market, and who publishes it

`GET /documents`

## Request

- Base URL: `https://api.craftquantities.com/v1`
- URL: `https://api.craftquantities.com/v1/documents`
- Auth: none declared

Never an edition or a date: adoption is local, and the answer names who decides.

## Query parameters

- `market` string, required: US, CA, UK, AU or INTL — or a country's name ("England", "Canada"); a country the site has no market for answers as INTL.
- `subject` string: The work, in words: "kitchen wiring", "stair handrails", "gas boiler flue".
- `calculator` string: Or a calculator's slug: the subjects its own sources name.
- `detail` 'full' | 'summary': full (the default): the whole answer. summary: the result lines, the citation line and the page only — fewer tokens to read.
- `format` 'json' | 'md'

## Response `200`

The documents by subject, the adoption sentence and who decides.

- union
  - object
    - `engine` object, required
    - `market` 'US' | 'CA' | 'UK' | 'AU' | 'INTL', required
    - `place` string, required
    - `marketNote` string
    - `asked` object, required
    - `calculator` object
    - `matchedFrom` 'subject' | 'calculator-sources' | 'calculator-title', required
    - `subjects` object[], required
      - `topic` string, required
      - `subject` string, required
      - `documents` object[], required
        - `document` string, required: The document family, as the site names it — not an edition.
        - `publishers` string[], required
        - `standardsPages` string[], required
      - `none` string
      - `byMarket` object[]
        - `market` string, required
        - `place` string, required
        - `documents` object[], required
          - `document` string, required: The document family, as the site names it — not an edition.
          - `publishers` string[], required
          - `standardsPages` string[], required
    - `none` string
    - `adoption` string, required: The market's fixed sentence: adoption, edition and amendments are decided locally.
    - `decidedBy` string, required
    - `notice` string, required
    - `links` object, required
    - `citation` object, required
      - `author` string, required
      - `title` string, required
      - `version` string, nullable
      - `sourcesChecked` string, nullable
      - `url` string, required
      - `accessDate` string, nullable, required
      - `formats` object, required
        - `plain` string, required
        - `apa` string, required
        - `harvard` string, required
        - `bibtex` string, required
    - `licence` object, required
      - `name` string, required
      - `url` string, required
      - `attribution` string, required
  - object
    - `detail` 'summary', required
    - `tool` string, required
    - `title` string, required
    - `lines` object[], required: The result lines, as the report's table gives them.
    - `notes` string[], required: What a professional must decide, when to call one, a false-friend warning, that adoption is local: kept in every summary.
    - `citation` string, required: The one citation line, built from the answer's own data.
    - `url` string, nullable, required
    - `open` string, nullable, required
    - `more` string, nullable, required

## Other responses

- `400`: The request was refused; every problem is listed.
- `404`: The request was refused; every problem is listed.

---

[API](https://skmtc.dev/craftquantities/apis/craft-quantities-engine-api.md) · [All operations](https://skmtc.dev/craftquantities/apis/craft-quantities-engine-api/llms.txt) · [OpenAPI document](https://skmtc.dev/craftquantities/apis/craft-quantities-engine-api/revisions/a69883abc23b?raw)