Blueprints / Markups

List a sheet's markups

The sheet's markups (revision clouds, highlights and notes with an arrow), made in the Kamai app, its chat or this API, oldest first. Markups are review marks: they are never counted as elements or measured.

Positions are fractions of the page, [x, y] in 0..1 from the top-left corner: box is [x0, y0, x1, y1], points a highlight's stroke (or a cloud's outline when it is not a box), pointer a note's arrow tip. room and room_id name the room a note points at; a note the app pinned to an element carries element and element_id instead. version is what an update or a delete sends back. updated_at_max moves on every change, deletes included, so poll it to know when to read again.

get/v1/blueprints/{blueprint_id}/markups

Request

  • Base URL: https://api.kamai.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.kamai.io/v1/blueprints/{blueprint_id}/markups
  • Auth: HTTP bearer

Path parameters

blueprint_idstring required

Response

Successful Response

blueprint_idstring required

The sheet.

namestring required

The sheet's label, as GET /v1/projects/{id}/sheets shows it.

updated_at_maxstring nullable

The latest change on the sheet's markups, deletes included: refetch only when it moves.

Changes

No recorded changes to this operation across all 1 revision of this API.