listBlocks 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 }.
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<BlockListResponse?> listBlocks(String id, { String? accountId, String? xWorkspaceID, String? parentId, int? limit, int? offset, }) async {
final response = await listBlocksWithHttpInfo(id, accountId: accountId, xWorkspaceID: xWorkspaceID, parentId: parentId, limit: limit, offset: offset, );
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
// When a remote server returns no body with a status of 204, we shall not decode it.
// At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
// FormatException when trying to decode an empty string.
if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'BlockListResponse',) as BlockListResponse;
}
return null;
}