Back
get /v1/blocks/{parentBlockId}/children

List block children

Returns a page of the block's direct children in the block's own order, each with its 1-based position and its own child count. Filter by type or by text contained in the title. Follow nextCursor to continue.

path params

parentBlockIdstring required

query params

typesarray of strings

Only children of these types; empty lists every type.

Enum values:
BLOCK_TYPE_UNSPECIFIED
BLOCK_TYPE_PAGE
BLOCK_TYPE_SECTION
BLOCK_TYPE_HEADING
BLOCK_TYPE_TEXT
BLOCK_TYPE_BULLETED_LIST_ITEM
BLOCK_TYPE_NUMBERED_LIST_ITEM
BLOCK_TYPE_FILE
BLOCK_TYPE_IMAGE
BLOCK_TYPE_CHECKBOX_LIST_ITEM
BLOCK_TYPE_CALLOUT
BLOCK_TYPE_QUOTE
BLOCK_TYPE_DIVIDER
BLOCK_TYPE_EMBED
BLOCK_TYPE_LINK_PREVIEW
BLOCK_TYPE_TABLE
BLOCK_TYPE_BUTTON
BLOCK_TYPE_CODE
BLOCK_TYPE_VIDEO
BLOCK_TYPE_AUDIO
BLOCK_TYPE_SYNCED_BLOCK
BLOCK_TYPE_TABLE_OF_CONTENTS
BLOCK_TYPE_CALENDAR
BLOCK_TYPE_TEMPLATE
BLOCK_TYPE_WORKFLOW
BLOCK_TYPE_ROOM
BLOCK_TYPE_EVENT
BLOCK_TYPE_POLL
BLOCK_TYPE_AUDIO_MESSAGE
BLOCK_TYPE_VIDEO_MESSAGE
BLOCK_TYPE_CANVAS
BLOCK_TYPE_FIND_A_TIME
BLOCK_TYPE_FORM
BLOCK_TYPE_GOAL
BLOCK_TYPE_DATABASE
BLOCK_TYPE_DATABASE_ITEM
BLOCK_TYPE_CHART
BLOCK_TYPE_ASSIGNMENT
BLOCK_TYPE_QUIZ
BLOCK_TYPE_RUBRIC
BLOCK_TYPE_GRADES
BLOCK_TYPE_PARAGRAPH
BLOCK_TYPE_SLIDES
BLOCK_TYPE_SLIDE
BLOCK_TYPE_COLUMN_LIST
BLOCK_TYPE_COLUMN
BLOCK_TYPE_TABS
BLOCK_TYPE_TAB
cursorstring
pageSizeinteger

Defaults to 50 when 0.

titleContainsstring

Keeps the children whose text contains this, ignoring case.

Responses

Was this guide helpful?