articles

Retrieve

Returns an Article object with the given id.

get/knowledgebase/v1/articles/{id}

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/knowledgebase/v1/articles/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

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_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).

Headers

X-Account-Tokenstring required

Token identifying the end user.

Response

idstring uuid
remote_idstring nullable

The third-party API ID of the matching object.

created_atstring date-time

The datetime that this object was created by Merge.

modified_atstring date-time

The datetime that this object was modified by Merge.

titlestring nullable

The title of the article.

descriptionstring nullable

Description of the article.

authorstring uuid nullable

The user who created the article.

last_edited_bystring uuid nullable

The user to last update the article.

visibility'PUBLIC' | 'INTERNAL' | 'RESTRICTED'
  • PUBLIC - PUBLIC
  • INTERNAL - INTERNAL
  • RESTRICTED - RESTRICTED
article_content_download_urlstring nullable

The presigned S3 URL to fetch article content.

checksumstring nullable

The SHA256 checksum of the article content.

article_urlstring nullable

The URL to the webpage of the article.

status'DRAFT' | 'PUBLISHED' | 'ARCHIVED' | 'TRASH'
  • DRAFT - DRAFT
  • PUBLISHED - PUBLISHED
  • ARCHIVED - ARCHIVED
  • TRASH - TRASH
type'PAGE' | 'BLOG_POST' | 'SMART_LINK'
  • PAGE - PAGE
  • BLOG_POST - BLOG_POST
  • SMART_LINK - SMART_LINK
remote_created_atstring date-time nullable

When the third party's article was created.

remote_updated_atstring date-time nullable

When the third party's article was updated.

parent_articlestring uuid nullable

The parent article an article is nested within.

parent_containerstring uuid nullable

The parent container an article is nested within.

root_containerstring uuid nullable

The top-level container in the hierarchy that holds this article. This will reference a container object that will typically be a SPACE or WORKSPACE type.

attachmentsstring[]
remote_was_deletedboolean

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.

field_mappingsArticleFieldMappings

Changes

No recorded changes to this operation across all 1 revision of this API.