> This page is for Unified. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.merge.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server. # /articles GET https://api.merge.dev/api/knowledgebase/v1/articles Returns a list of `Article` objects. Reference: https://docs.merge.dev/merge-unified/knowledge-base/common-models/articles/list ## Authentication - `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer" ## Servers - `https://api.merge.dev/api` (Production, default) - `https://api-eu.merge.dev/api` (ProductionEU) - `https://api-ap.merge.dev/api` (ProductionAPSE1) - `https://api-ap.merge.dev/api/knowledgebase/v1` (ProductionAPSE1) ## Request ### Query parameters - `created_after` (datetime, optional) — If provided, will only return objects created after this datetime. - `created_before` (datetime, optional) — If provided, will only return objects created before this datetime. - `cursor` (string, optional) — The pagination cursor value. - `expand` (enum, optional) — Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. - Allowed values: `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` - `include_deleted_data` (boolean, 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](https://docs.merge.dev/integrations/hris/supported-features/). - `include_remote_data` (boolean, optional) — Whether to include the original data Merge fetched from the third-party to produce these models. - `include_shell_data` (boolean, optional) — Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null). - `modified_after` (datetime, optional) — If provided, only objects synced by Merge after this date time will be returned. - `modified_before` (datetime, optional) — If provided, only objects synced by Merge before this date time will be returned. - `page_size` (integer, optional) — Number of results to return per page. The maximum limit is 100. - `parent_article_id` (string, optional) — If provided, will only return sub articles of the parent_article_id. - `parent_container_id` (string, optional) — If provided, will only return sub articles of the parent_container_id. - `remote_id` (string, optional) — The API provider's ID for the given object. - `root_container_id` (string, optional) — If provided, will only return sub articles of the root_container_id. - `status` (string, optional) — If provided, will only return articles of the given status; multiple statuses can be separated by commas. - `type` (enum, optional) — If provided, will only return articles of the given type. - Allowed values: ``, `BLOG_POST`, `PAGE`, `SMART_LINK` ### Headers - `X-Account-Token` (string, required) — Token identifying the end user. ## Response ### 200 - `next` (string, optional, nullable) - `previous` (string, optional, nullable) - `results` (list of Article, optional) ## Types ### Article # The Article Object ### Description The `Article` object is used to represent a form of content in the knowledge base, such as an article or page. ### Usage Example Fetch from the `GET /api/knowledgebase/articles` endpoint and view their articles. - `id` (string, optional) - `remote_id` (string, optional, nullable) — The third-party API ID of the matching object. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `title` (string, optional, nullable) — The title of the article. - `description` (string, optional, nullable) — Description of the article. - `author` (string, optional, nullable) — The user who created the article. - `last_edited_by` (string, optional, nullable) — The user to last update the article. - `visibility` (enum, optional, nullable) — The visibility of the article. * `PUBLIC` - PUBLIC * `INTERNAL` - INTERNAL * `RESTRICTED` - RESTRICTED - Allowed values: `PUBLIC`, `INTERNAL`, `RESTRICTED` - `article_content_download_url` (string, optional, nullable) — The presigned S3 URL to fetch article content. - `checksum` (string, optional, nullable) — The SHA256 checksum of the article content. - `article_url` (string, optional, nullable) — The URL to the webpage of the article. - `status` (enum, optional, nullable) — The status of the article. * `DRAFT` - DRAFT * `PUBLISHED` - PUBLISHED * `ARCHIVED` - ARCHIVED * `TRASH` - TRASH - Allowed values: `DRAFT`, `PUBLISHED`, `ARCHIVED`, `TRASH` - `type` (enum, optional, nullable) — The type of the article. * `PAGE` - PAGE * `BLOG_POST` - BLOG_POST * `SMART_LINK` - SMART_LINK - Allowed values: `PAGE`, `BLOG_POST`, `SMART_LINK` - `remote_created_at` (datetime, optional, nullable) — When the third party's article was created. - `remote_updated_at` (datetime, optional, nullable) — When the third party's article was updated. - `parent_article` (string, optional, nullable) — The parent article an article is nested within. - `parent_container` (string, optional, nullable) — The parent container an article is nested within. - `root_container` (string, optional, 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. - `permissions` (list of Permission, optional) - `attachments` (list of string, optional) - `remote_was_deleted` (boolean, 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](https://docs.merge.dev/integrations/hris/supported-features/). - `field_mappings` (ArticleFieldMappings, optional, nullable) - `remote_data` (list of RemoteData, optional, nullable) ### Permission # The Permission Object ### Description The `Permission` object is used to represent a user's or group's access to an article or container. Permissions are unexpanded by default. ### Usage Example - `id` (string, optional) - `remote_id` (string, optional, nullable) — The third-party API ID of the matching object. - `created_at` (datetime, optional) — The datetime that this object was created by Merge. - `modified_at` (datetime, optional) — The datetime that this object was modified by Merge. - `user` (string, optional, nullable) - `group` (string, optional, nullable) - `type` (enum, optional, nullable) — Denotes what type of people have access to the Article or Container. * `USER` - USER * `GROUP` - GROUP * `COMPANY` - COMPANY * `ANYONE` - ANYONE - Allowed values: `USER`, `GROUP`, `COMPANY`, `ANYONE` - `roles` (list of enum, optional, nullable) — 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. - Allowed values: `READ`, `WRITE`, `OWNER` - `remote_was_deleted` (boolean, 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](https://docs.merge.dev/integrations/hris/supported-features/). - `field_mappings` (PermissionFieldMappings, optional, nullable) ### ArticleFieldMappings ### RemoteData # The RemoteData Object ### Description The `RemoteData` object is used to represent the full data pulled from the third-party API for an object. - `path` (string, required) — The third-party API path that is being called. - `data` (any, optional) — The data returned from the third-party for this object in its original, unnormalized format. ### PermissionFieldMappings ## Examples **Response** ```json { "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw", "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ", "results": [ { "id": "134e0111-0f67-44f6-98f0-597000290bb3", "remote_id": "800293", "created_at": "2021-09-15T00:00:00Z", "modified_at": "2021-10-16T00:00:00Z", "title": "Test Article", "description": "This article describes how Merge is the #1 player in the Unified API space", "author": "2872ba14-4084-492b-be96-e5eee6fc33ef", "last_edited_by": "9871b4a9-f5d2-4f3b-a66b-dfedbed42c46", "visibility": "INTERNAL", "article_content_download_url": "https://s3.amazonaws.com/finance-department-bucket/2022/tax-certificate.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA3SGQVQG7FGA6KKA6%2F20221104%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20221104T140227Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=b228dbec8c1008c80c162e1210e4503dceead1e4d4751b4d9787314fd6da4d55", "checksum": "b228dbec8c1008c80c162e1210e4503dceead1e4d4751b4d9787314fd6da4d55", "article_url": "myworkspace.atlassian.net/wiki/test-article", "status": "DRAFT", "type": "PAGE", "remote_created_at": "2021-09-15T00:00:00Z", "remote_updated_at": "2021-09-16T00:00:00Z", "parent_article": "string", "parent_container": "8e889422-e086-42dc-b99e-24d732039b0b", "root_container": "d34ab990-71f8-49ba-985d-a502f0752fe1", "permissions": [ { "id": "31ce489c-asdf-68b1-754r-629f799f7123", "remote_id": "102895", "created_at": "2020-03-31T00:00:00Z", "modified_at": "2020-06-20T00:00:00Z", "user": "21ce474c-asdf-34a2-754r-629f799f7d12", "group": null, "type": "USER", "roles": [ "OWNER" ], "remote_data": null } ], "attachments": [ "640b80b-fac9-409f-aa19-1f9221aec445" ], "remote_was_deleted": true, "field_mappings": { "linked_account_defined_targets": { "custom_key": "custom_value" }, "organization_defined_targets": { "custom_key": "custom_value" } }, "remote_data": [ { "path": "/articles", "data": null } ] } ] } ``` **SDK Code** ```python import requests url = "https://api.merge.dev/api/knowledgebase/v1/articles" querystring = {"include_remote_data":"true"} headers = { "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.merge.dev/api/knowledgebase/v1/articles?include_remote_data=true'; const options = { method: 'GET', headers: {'X-Account-Token': 'X-Account-Token', Authorization: 'Bearer '} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.merge.dev/api/knowledgebase/v1/articles?include_remote_data=true" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("X-Account-Token", "X-Account-Token") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.merge.dev/api/knowledgebase/v1/articles?include_remote_data=true") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["X-Account-Token"] = 'X-Account-Token' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.merge.dev/api/knowledgebase/v1/articles?include_remote_data=true") .header("X-Account-Token", "X-Account-Token") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.merge.dev/api/knowledgebase/v1/articles?include_remote_data=true', [ 'headers' => [ 'Authorization' => 'Bearer ', 'X-Account-Token' => 'X-Account-Token', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.merge.dev/api/knowledgebase/v1/articles?include_remote_data=true"); var request = new RestRequest(Method.GET); request.AddHeader("X-Account-Token", "X-Account-Token"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-Account-Token": "X-Account-Token", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.merge.dev/api/knowledgebase/v1/articles?include_remote_data=true")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```