Skip to content

Get Readiness Sections

GET
/api/canvas/{deal_id}/readiness/sections
curl --request GET \
--url https://example.com/api/canvas/example/readiness/sections \
--header 'Authorization: Bearer <token>'

Get per-section readiness breakdown for a deal.

Returns one entry per canonical section with quality score, grade, approval status, staleness flag, word count, and content status (present/missing/insufficient).

deal_id
required
Deal Id
string

Successful Response

Media type application/json
ReadinessSectionsResponse

Per-section readiness response — emitted by GET /canvas/{deal_id}/readiness/sections.

object
deal_id
required
Deal Id
string
sections
required
Sections
Array<object>
object
key
additional properties
any
computed_at
required
Computed At
number
key
additional properties
any
Example generated
{
"deal_id": "example",
"sections": [
{}
],
"computed_at": 1
}

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}