Articles
The Article object is used to represent an article in the knowledge base.
Properties
idUUID
remote_idString
The 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.
titleString
The title of the article.
descriptionString
Description of the article.
authorUUID
The user who created the article.
last_edited_byUUID
The user to last update the article.
visibilityEnum
The 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_urlString
The presigned S3 URL to fetch article content.
checksumString
The SHA256 checksum of the article content.
article_urlString
The URL to the webpage of the article.
statusEnum
The 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.
typeEnum
The 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_articleUUID
The parent article an article is nested within.
parent_containerUUID
The parent container an article is nested within.
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
idUUID
remote_idString
The 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.
userUUID
groupUUID
typeEnum
Denotes 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.
rolesArray
The 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_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_mappingsObject
attachmentsAttachment[]
The Attachment object
The Attachment object is used to represent an attachment to an article or container.
Properties
idUUID
remote_idString
The 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.
nameString
The attachment's name.
descriptionString
The attachment's description.
attachment_urlString
The attachment's url.
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_mappingsObject
remote_dataRemoteData[]
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_mappingsObject
remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties
pathString
The third-party API path that is being called.
dataAny
The 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.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
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
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
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_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Confluence
Confluence
Not 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
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
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
Confluence
Not seeing an integration that you're looking for?
Previous
Overview
Next Up
Attachments