Articles
The
Article object is used to represent a form of content in the knowledge base, such as an article or page.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
titleStringThe title of the article.
descriptionStringDescription of the article.
authorUUIDThe user who created the article.
last_edited_byUUIDThe user to last update the article.
visibilityEnumThe visibility of the article. Possible values include:
PUBLIC, INTERNAL, RESTRICTED. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.article_content_download_urlStringThe presigned S3 URL to fetch article content.
checksumStringThe SHA256 checksum of the article content.
article_urlStringThe URL to the webpage of the article.
statusEnumThe status of the article. Possible values include:
DRAFT, PUBLISHED, ARCHIVED, TRASH. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.typeEnumThe type of the article. Possible values include:
PAGE, BLOG_POST, SMART_LINK. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_created_atDateTime (ISO 8601)When the third party's article was created.
remote_updated_atDateTime (ISO 8601)When the third party's article was updated.
parent_articleUUIDThe parent article an article is nested within.
parent_containerUUIDThe parent container an article is nested within.
root_containerUUIDThe 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.
permissionsPermission[]The Permission object
The
Permission object is used to represent a user's or group's access to an article or container. Permissions are unexpanded by default.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
userUUIDgroupUUIDtypeEnumDenotes what type of people have access to the Article or Container. Possible values include:
USER, GROUP, COMPANY, ANYONE. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.rolesArrayThe permissions that the user or group has for the Article or Container. It is possible for a user or group to have multiple roles, such as viewing & uploading.
remote_was_deletedBooleanIndicates 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_mappingsObjectattachmentsArrayremote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/articles
https://api.merge.dev/api/knowledgebase/v1/articles
US
EU
APAC
Returns a list of Article objects.
Query & path parameters
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBooleanOptional
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_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).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.
parent_article_idStringOptional
If provided, will only return sub articles of the parent_article_id.
parent_container_idStringOptional
If provided, will only return sub articles of the parent_container_id.
remote_idStringOptional
The API provider's ID for the given object.
root_container_idStringOptional
If provided, will only return sub articles of the root_container_id.
statusStringOptional
If provided, will only return articles of the given status; multiple statuses can be separated by commas.
typeStringOptional
If provided, will only return articles of the given type.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Confluence
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
article_content_download_urlStringarticle_urlStringattachmentsArrayauthorUUIDchecksumStringlast_edited_byUUIDparent_articleUUIDparent_containerUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_was_deletedbooleanfield_mappingsobjectremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)root_containerUUIDstatusEnumtitleStringtypeEnum
Notion
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
article_content_download_urlStringarticle_urlStringattachmentsArrayauthorUUIDchecksumStringlast_edited_byUUIDparent_articleUUIDparent_containerUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtitleStringtypeEnumvisibilityEnumNot seeing an integration that you're looking for?
GET
/articles/{id}
https://api.merge.dev/api/knowledgebase/v1/articles/{id}
US
EU
APAC
Returns an Article object with the given id.
Query & path parameters
expandStringOptional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUIDRequired
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).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Confluence
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
article_content_download_urlStringarticle_urlStringattachmentsArrayauthorUUIDchecksumStringlast_edited_byUUIDparent_articleUUIDparent_containerUUIDpermissionsPermission[]idstringremote_idstringcreated_atstringmodified_atstringuserstringgroupstringtypestringrolesarrayremote_was_deletedbooleanfield_mappingsobjectremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)root_containerUUIDstatusEnumtitleStringtypeEnumNotion
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
article_content_download_urlStringarticle_urlStringattachmentsArrayauthorUUIDchecksumStringlast_edited_byUUIDparent_articleUUIDparent_containerUUIDremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)statusEnumtitleStringtypeEnumvisibilityEnumNot seeing an integration that you're looking for?