articles
List
Returns a list of Article objects.
get/knowledgebase/v1/articles
Request
- Base URL: https://api.merge.dev/api
- URL: https://api.merge.dev/api/knowledgebase/v1/articles
- Auth: HTTP bearer
Query parameters
created_afterstring date-time
If provided, will only return objects created after this datetime.
created_beforestring date-time
If provided, will only return objects created before this datetime.
cursorstring
The pagination cursor value.
expand'attachments' | 'attachments,author' | 'attachments,author,last_edited_by' | 'attachments,author,last_edited_by,parent_article' | 'attachments,author,last_edited_by,parent_article,parent_container' | 'attachments,author,last_edited_by,parent_article,parent_container,root_container' | 'attachments,author,last_edited_by,parent_article,root_container' | 'attachments,author,last_edited_by,parent_container' | 'attachments,author,last_edited_by,parent_container,root_container' | 'attachments,author,last_edited_by,root_container' | 'attachments,author,parent_article' | 'attachments,author,parent_article,parent_container' | 'attachments,author,parent_article,parent_container,root_container' | 'attachments,author,parent_article,root_container' | 'attachments,author,parent_container' | 'attachments,author,parent_container,root_container' | 'attachments,author,root_container' | 'attachments,last_edited_by' | 'attachments,last_edited_by,parent_article' | 'attachments,last_edited_by,parent_article,parent_container' | 'attachments,last_edited_by,parent_article,parent_container,root_container' | 'attachments,last_edited_by,parent_article,root_container' | 'attachments,last_edited_by,parent_container' | 'attachments,last_edited_by,parent_container,root_container' | 'attachments,last_edited_by,root_container' | 'attachments,parent_article' | 'attachments,parent_article,parent_container' | 'attachments,parent_article,parent_container,root_container' | 'attachments,parent_article,root_container' | 'attachments,parent_container' | 'attachments,parent_container,root_container' | 'attachments,root_container' | 'author' | 'author,last_edited_by' | 'author,last_edited_by,parent_article' | 'author,last_edited_by,parent_article,parent_container' | 'author,last_edited_by,parent_article,parent_container,root_container' | 'author,last_edited_by,parent_article,root_container' | 'author,last_edited_by,parent_container' | 'author,last_edited_by,parent_container,root_container' | 'author,last_edited_by,root_container' | 'author,parent_article' | 'author,parent_article,parent_container' | 'author,parent_article,parent_container,root_container' | 'author,parent_article,root_container' | 'author,parent_container' | 'author,parent_container,root_container' | 'author,root_container' | 'last_edited_by' | 'last_edited_by,parent_article' | 'last_edited_by,parent_article,parent_container' | 'last_edited_by,parent_article,parent_container,root_container' | 'last_edited_by,parent_article,root_container' | 'last_edited_by,parent_container' | 'last_edited_by,parent_container,root_container' | 'last_edited_by,root_container' | 'parent_article' | 'parent_article,parent_container' | 'parent_article,parent_container,root_container' | 'parent_article,root_container' | 'parent_container' | 'parent_container,root_container' | 'permissions' | 'permissions,attachments' | 'permissions,attachments,author' | 'permissions,attachments,author,last_edited_by' | 'permissions,attachments,author,last_edited_by,parent_article' | 'permissions,attachments,author,last_edited_by,parent_article,parent_container' | 'permissions,attachments,author,last_edited_by,parent_article,parent_container,root_container' | 'permissions,attachments,author,last_edited_by,parent_article,root_container' | 'permissions,attachments,author,last_edited_by,parent_container' | 'permissions,attachments,author,last_edited_by,parent_container,root_container' | 'permissions,attachments,author,last_edited_by,root_container' | 'permissions,attachments,author,parent_article' | 'permissions,attachments,author,parent_article,parent_container' | 'permissions,attachments,author,parent_article,parent_container,root_container' | 'permissions,attachments,author,parent_article,root_container' | 'permissions,attachments,author,parent_container' | 'permissions,attachments,author,parent_container,root_container' | 'permissions,attachments,author,root_container' | 'permissions,attachments,last_edited_by' | 'permissions,attachments,last_edited_by,parent_article' | 'permissions,attachments,last_edited_by,parent_article,parent_container' | 'permissions,attachments,last_edited_by,parent_article,parent_container,root_container' | 'permissions,attachments,last_edited_by,parent_article,root_container' | 'permissions,attachments,last_edited_by,parent_container' | 'permissions,attachments,last_edited_by,parent_container,root_container' | 'permissions,attachments,last_edited_by,root_container' | 'permissions,attachments,parent_article' | 'permissions,attachments,parent_article,parent_container' | 'permissions,attachments,parent_article,parent_container,root_container' | 'permissions,attachments,parent_article,root_container' | 'permissions,attachments,parent_container' | 'permissions,attachments,parent_container,root_container' | 'permissions,attachments,root_container' | 'permissions,author' | 'permissions,author,last_edited_by' | 'permissions,author,last_edited_by,parent_article' | 'permissions,author,last_edited_by,parent_article,parent_container' | 'permissions,author,last_edited_by,parent_article,parent_container,root_container' | 'permissions,author,last_edited_by,parent_article,root_container' | 'permissions,author,last_edited_by,parent_container' | 'permissions,author,last_edited_by,parent_container,root_container' | 'permissions,author,last_edited_by,root_container' | 'permissions,author,parent_article' | 'permissions,author,parent_article,parent_container' | 'permissions,author,parent_article,parent_container,root_container' | 'permissions,author,parent_article,root_container' | 'permissions,author,parent_container' | 'permissions,author,parent_container,root_container' | 'permissions,author,root_container' | 'permissions,last_edited_by' | 'permissions,last_edited_by,parent_article' | 'permissions,last_edited_by,parent_article,parent_container' | 'permissions,last_edited_by,parent_article,parent_container,root_container' | 'permissions,last_edited_by,parent_article,root_container' | 'permissions,last_edited_by,parent_container' | 'permissions,last_edited_by,parent_container,root_container' | 'permissions,last_edited_by,root_container' | 'permissions,parent_article' | 'permissions,parent_article,parent_container' | 'permissions,parent_article,parent_container,root_container' | 'permissions,parent_article,root_container' | 'permissions,parent_container' | 'permissions,parent_container,root_container' | 'permissions,root_container' | 'root_container'
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_databoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
include_remote_databoolean
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_databoolean
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
modified_afterstring date-time
If provided, only objects synced by Merge after this date time will be returned.
modified_beforestring date-time
If provided, only objects synced by Merge before this date time will be returned.
page_sizeinteger
Number of results to return per page. The maximum limit is 100.
parent_article_idstring
If provided, will only return sub articles of the parent_article_id.
parent_container_idstring
If provided, will only return sub articles of the parent_container_id.
remote_idstring
The API provider's ID for the given object.
root_container_idstring
If provided, will only return sub articles of the root_container_id.
statusstring
If provided, will only return articles of the given status; multiple statuses can be separated by commas.
type'' | 'BLOG_POST' | 'PAGE' | 'SMART_LINK'
If provided, will only return articles of the given type.
Headers
X-Account-Tokenstring required
Token identifying the end user.
Response
Changes
No recorded changes to this operation across all 1 revision of this API.