Skip to navigation
API ReferenceReusable Blocks

List reusable blocks OAuth Scope: posts:read

Currently in beta

This feature is currently in beta and the API is subject to change.

Retrieve the reusable blocks that belong to the workspace. A reusable block is a header, footer, or set of content blocks that every publication in the workspace can use in its posts and templates. Archived blocks are excluded unless the status parameter asks for them.

Requires an API key with access to every publication in the workspace.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional
A limit on the number of objects to be returned. The limit can range between 1 and 100, and the default is 10.
cursorstringOptional

Cursor-based pagination (recommended): Use this opaque cursor token to fetch the next page of results. When provided, pagination will use cursor-based method which is more efficient and consistent than offset-based pagination.

pageintegerOptional

Offset-based pagination (deprecated): Page number for offset-based pagination. Please migrate to cursor-based pagination using the cursor parameter. If not specified, results 1-10 from page 1 will be returned.

kind[]enumOptional
Only return blocks of these kinds. Defaults to every kind.
Allowed values:
statusenumOptional

Filter blocks by whether they have been archived. Defaults to active.

Allowed values:

Response

OK
datalist of objects
An array of reusable blocks.
limitintegerOptional
The limit placed on the results. If no limit was specified in the request, this defaults to 10.
has_morebooleanOptional

Cursor pagination only: Indicates whether there are more results available after the current page. Only present when using cursor-based pagination.

next_cursorstringOptional

Cursor pagination only: The cursor token to use for fetching the next page of results. This will be null if has_more is false. Only present when using cursor-based pagination.

pageintegerOptional

Offset pagination only: The page of results returned. Only present when using the deprecated page parameter.

total_resultsintegerOptional
The total number of results from all pages.
total_pagesintegerOptional

Offset pagination only: The total number of pages. Only present when using the deprecated page parameter.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error