List Articles (POST)
Lists a collection of articles.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
applies_to_parts
Filters for articles belonging to any of the provided parts.
article_type
Filter for the type of articles. If this is not provided, then
articles that are not content blocks are returned.
Allowed values:
brands
Filters for articles belonging to any of the provided brands.
created_by
Filters for articles created by any of the provided users.
cursor
The cursor to resume iteration from. If not provided, then
iteration starts from the beginning.
limit
The maximum number of articles to return. The default is '50'.
mode
The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.
Allowed values:
modified_by
Filters for articles modified by any of the provided users.
owned_by
Filters for articles owned by any of the provided users.
scope
Filter for the scope of the articles.
Response
List articles response.
articles
The article entries matching the request.
total
Total number of article items for the request.
next_cursor
The cursor used to iterate subsequent results in accordance to the
sort order. If not set, then no later elements exist.
prev_cursor
The cursor used to iterate preceding results in accordance to the
sort order. If not set, then no prior elements exist.