---
title: "The planner's ids for one kind of space"
method: GET
path: "/planner/{kind}"
tags: ["Planner"]
---

# The planner's ids for one kind of space

`GET /planner/{kind}`

## Request

- Base URL: `https://api.craftquantities.com/v1`
- URL: `https://api.craftquantities.com/v1/planner/{kind}`
- Auth: none declared

## Path parameters

- `kind` 'room' | 'bathroom' | 'slab' | 'deck' | 'driveway' | 'fence' | 'loft' | 'retaining-wall' | 'exterior-wall' | 'stair', required: The kind of space: a room or a bathroom (from its size, doors and windows), or a slab, deck, driveway, fence, loft, retaining wall, exterior wall or stair.

## Query parameters

- `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`

Figures, surfaces and finishes, scope questions, trades, branches and decisions.

- union
  - object
    - `kind` string, required
    - `modelSchemaVersion` integer, required
    - `url` string, required
    - `figures` object[], required
    - `openings` unknown[]
      - unknown
    - `surfaces` object[], required
    - `scope` object[], required
    - `intents` string[], required
    - `branches` object[], required
    - `decisions` object, 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.

---

[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)