Sign in
blocks

List blocks

List blocks with cursor-based pagination. Returns both shared project blocks and blocks saved by end-users; each user-saved block carries the userId it was saved under (null for shared blocks), so usage can be aggregated per end-user without enumerating user IDs. Returns blocks in descending order by creation.

get/v3/blocks

Request

  • Base URL: https://api.unlayer.com
  • URL: https://api.unlayer.com/v3/blocks
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

projectIdstring

The project ID to list blocks for

limitinteger

Number of blocks to return (1-100)

cursorstring

Pagination cursor from previous response

displayMode'email' | 'web' | 'popup' | 'document'

Filter by display mode

userIdstring

Only blocks saved by this end-user (exact match on the user id your app passes to the editor)

scope'all' | 'shared' | 'user'

Filter by block ownership: shared project blocks, end-user saved blocks, or both

categorystring

Filter by category (case-insensitive search)

includeDataboolean

Include the block design JSON in each item. Pass false for lightweight sweeps (e.g. usage reports).

Response

Default Response

next_cursorstring nullable

Cursor for the next page. Null if no more results.

has_moreboolean required

Whether there are more results after this page

Changes

No recorded changes to this operation across all 2 revisions of this API.