listBlocksWithHttpInfo method
List blocks under a note.
Returns the block tree for a note, paginated. Block listing always targets a single account (the one that owns the note) so it does not fan out — the response is a plain { blocks, total }.
Note: This method returns the HTTP Response.
Parameters:
-
String id (required): Note id.
-
String accountId: Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with
provider. If omitted on a list endpoint the call fans out across every connected account. -
String xWorkspaceID: Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.
-
String parentId: Filter to children of this block id. Omit to list root-level blocks.
-
int limit:
-
int offset:
Implementation
Future<Response> listBlocksWithHttpInfo(String id, { String? accountId, String? xWorkspaceID, String? parentId, int? limit, int? offset, }) async {
// ignore: prefer_const_declarations
final path = r'/v1/notes/{id}/blocks'
.replaceAll('{id}', id);
// ignore: prefer_final_locals
Object? postBody;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
if (accountId != null) {
queryParams.addAll(_queryParams('', 'accountId', accountId));
}
if (parentId != null) {
queryParams.addAll(_queryParams('', 'parent_id', parentId));
}
if (limit != null) {
queryParams.addAll(_queryParams('', 'limit', limit));
}
if (offset != null) {
queryParams.addAll(_queryParams('', 'offset', offset));
}
if (xWorkspaceID != null) {
headerParams[r'X-Workspace-ID'] = parameterToString(xWorkspaceID);
}
const contentTypes = <String>[];
return apiClient.invokeAPI(
path,
'GET',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}