Common ModelsArticles

/articles/{id}

Returns an Article object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

expandenumOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringRead-onlyformat: "uuid"
remote_idstring or null

The third-party API ID of the matching object.

created_atdatetimeRead-only
The datetime that this object was created by Merge.
modified_atdatetimeRead-only
The datetime that this object was modified by Merge.
titlestring or null<=254 characters
The title of the article.
descriptionstring or null<=2000 characters
Description of the article.
authorstring or nullformat: "uuid"
The user who created the article.
last_edited_bystring or nullformat: "uuid"
The user to last update the article.
visibilityenum or null

The visibility of the article.

  • PUBLIC - PUBLIC
  • INTERNAL - INTERNAL
  • RESTRICTED - RESTRICTED
article_content_download_urlstring or nullRead-only
The presigned S3 URL to fetch article content.
checksumstring or null<=254 characters
The SHA256 checksum of the article content.
article_urlstring or null<=2000 characters
The URL to the webpage of the article.
statusenum or null

The status of the article.

  • DRAFT - DRAFT
  • PUBLISHED - PUBLISHED
  • ARCHIVED - ARCHIVED
  • TRASH - TRASH
typeenum or null

The type of the article.

  • PAGE - PAGE
  • BLOG_POST - BLOG_POST
  • SMART_LINK - SMART_LINK
remote_created_atdatetime or null
When the third party's article was created.
remote_updated_atdatetime or null
When the third party's article was updated.
parent_articlestring or nullformat: "uuid"
The parent article an article is nested within.
parent_containerstring or nullformat: "uuid"
The parent container an article is nested within.
root_containerstring or nullformat: "uuid"

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.

permissionslist of objects
attachmentslist of strings
remote_was_deletedbooleanRead-only

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_mappingsobject or nullRead-only
remote_datalist of objects or nullRead-only