STstreakyc
Boxes

Get box markdown

Changed on

Returns the box as one markdown document: an overview, its columns, contacts, organizations, linked boxes, tasks and pipeline, followed by its timeline. Every timestamp is ISO-8601 UTC. The document's structure is best-effort and may change; use the JSON endpoints for a stable contract.

get/v1/boxes/{boxKey}/md

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v1/boxes/{boxKey}/md
  • Auth
    HTTP bearer

Path parameters

boxKeystring required

Query parameters

maxTokensinteger nullable

A token cap for the entire document, counted with OpenAI's o200k_base encoding. It covers the box sections first, then uses the remaining tokens for the timeline. A marker shows where entries were left out. If the box does not fit under the cap, a 400 error shows the minimum it needs. Omit the cap to return the full box.

Response

The box rendered as one markdown document.

Changes