Documents
Retrieve a note
GET
https://api.q4.sa/v1/documents/{id}/notes/{number}Returns one note’s full text, its tables, and the figures in them.
Starter+
The text is the note as printed, split into paragraphs with the page each comes from, so you can quote an accounting policy or a contingency and cite it. Tables come back as rows of labels and the figure IDs in each cell.
Authorization
x-api-keyheaderrequiredPath parameters
idstringrequiredDocument ID, e.g.
doc_7Hk2pQ.numberstringrequiredNote number as printed, e.g.
27.Query parameters
formatstringParagraphs with pages, one Markdown block, or plain text.
One of:
paragraphsmarkdownplainDefault:
paragraphsinclude_tablesbooleanInclude the note’s tables.
Default:
trueResponse
dataobjectThe result.
document_idstringDocument the item came from.
numberstringtitlestringTitle.
pagesinteger[]Page count.
paragraphsobject[]The note’s text, in order.
pageintegerPage the paragraph is printed on.
textstringtablesobject[]Tables in the note.
titlestringTitle.
pageintegercolumnsstring[]rowsobject[]labelstringLine item label as printed.
fact_idsstring[]One figure ID per column. Fetch them with List figures, or match on
id.