{ "info": { "_postman_id": "eb0fec9f-f992-4ae8-afec-16e21569a8f4", "name": "Knowledge Base", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:11:20.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "lastUpdatedBy": "35240", "uid": "35240-eb0fec9f-f992-4ae8-afec-16e21569a8f4" }, "item": [ { "name": "knowledgebase", "item": [ { "name": "v1", "item": [ { "name": "articles", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve", "id": "9f5e2cf2-f157-4843-bf3c-b0c6c37f9baa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/articles/:id?expand=permissions,attachments,parent_container,root_container&include_remote_data=&include_shell_data=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "articles", ":id" ], "query": [ { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "permissions,attachments,parent_container,root_container" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" } ], "variable": [ { "id": "01fcf920-549b-4e26-b645-2e7856828243", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Returns an `Article` object with the given `id`." }, "response": [ { "id": "a88153a6-6c81-4566-a47d-03c985a7b07f", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/articles/:id?expand=permissions,attachments,parent_container,root_container&include_remote_data=&include_shell_data=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "articles", ":id" ], "query": [ { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "permissions,attachments,parent_container,root_container" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"author\": \"\",\n \"last_edited_by\": \"\",\n \"visibility\": \"INTERNAL\",\n \"article_content_download_url\": \"\",\n \"checksum\": \"\",\n \"article_url\": \"\",\n \"status\": \"ARCHIVED\",\n \"type\": \"BLOG_POST\",\n \"remote_created_at\": \"\",\n \"remote_updated_at\": \"\",\n \"parent_article\": \"\",\n \"parent_container\": \"\",\n \"root_container\": \"\",\n \"permissions\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"GROUP\",\n \"roles\": null,\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"ANYONE\",\n \"roles\": [\n \"WRITE\",\n \"READ\"\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n }\n ],\n \"attachments\": [\n \"\",\n \"\"\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": null\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-a88153a6-6c81-4566-a47d-03c985a7b07f" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-9f5e2cf2-f157-4843-bf3c-b0c6c37f9baa" } ], "id": "8802eeff-1be3-4935-aea3-351ae8bbda3e", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-8802eeff-1be3-4935-aea3-351ae8bbda3e" }, { "name": "List", "id": "369be3c5-041b-436d-81ef-7aebbb71f690", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/articles?created_after=&created_before=&cursor=&expand=author&include_deleted_data=&include_remote_data=&include_shell_data=&modified_after=&modified_before=&page_size=&parent_article_id=&parent_container_id=&remote_id=&root_container_id=&status=&type=PAGE", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "articles" ], "query": [ { "description": "If provided, will only return objects created after this datetime.", "key": "created_after", "value": "" }, { "description": "If provided, will only return objects created before this datetime.", "key": "created_before", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "author" }, { "description": "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/).", "key": "include_deleted_data", "value": "" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" }, { "description": "If provided, only objects synced by Merge after this date time will be returned.", "key": "modified_after", "value": "" }, { "description": "If provided, only objects synced by Merge before this date time will be returned.", "key": "modified_before", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "If provided, will only return sub articles of the parent_article_id.", "key": "parent_article_id", "value": "" }, { "description": "If provided, will only return sub articles of the parent_container_id.", "key": "parent_container_id", "value": "" }, { "description": "The API provider's ID for the given object.", "key": "remote_id", "value": "" }, { "description": "If provided, will only return sub articles of the root_container_id.", "key": "root_container_id", "value": "" }, { "description": "If provided, will only return articles of the given status; multiple statuses can be separated by commas.", "key": "status", "value": "" }, { "description": "If provided, will only return articles of the given type.", "key": "type", "value": "PAGE" } ] }, "description": "Returns a list of `Article` objects." }, "response": [ { "id": "b99342de-7605-4c84-92f7-0b04cfa03ac9", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/articles?created_after=&created_before=&cursor=&expand=author&include_deleted_data=&include_remote_data=&include_shell_data=&modified_after=&modified_before=&page_size=&parent_article_id=&parent_container_id=&remote_id=&root_container_id=&status=&type=PAGE", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "articles" ], "query": [ { "description": "If provided, will only return objects created after this datetime.", "key": "created_after", "value": "" }, { "description": "If provided, will only return objects created before this datetime.", "key": "created_before", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "author" }, { "description": "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/).", "key": "include_deleted_data", "value": "" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" }, { "description": "If provided, only objects synced by Merge after this date time will be returned.", "key": "modified_after", "value": "" }, { "description": "If provided, only objects synced by Merge before this date time will be returned.", "key": "modified_before", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "If provided, will only return sub articles of the parent_article_id.", "key": "parent_article_id", "value": "" }, { "description": "If provided, will only return sub articles of the parent_container_id.", "key": "parent_container_id", "value": "" }, { "description": "The API provider's ID for the given object.", "key": "remote_id", "value": "" }, { "description": "If provided, will only return sub articles of the root_container_id.", "key": "root_container_id", "value": "" }, { "description": "If provided, will only return articles of the given status; multiple statuses can be separated by commas.", "key": "status", "value": "" }, { "description": "If provided, will only return articles of the given type.", "key": "type", "value": "PAGE" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"author\": \"\",\n \"last_edited_by\": \"\",\n \"visibility\": \"PUBLIC\",\n \"article_content_download_url\": \"\",\n \"checksum\": \"\",\n \"article_url\": \"\",\n \"status\": \"PUBLISHED\",\n \"type\": \"SMART_LINK\",\n \"remote_created_at\": \"\",\n \"remote_updated_at\": \"\",\n \"parent_article\": \"\",\n \"parent_container\": \"\",\n \"root_container\": \"\",\n \"permissions\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"COMPANY\",\n \"roles\": [\n \"WRITE\",\n \"OWNER\"\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"ANYONE\",\n \"roles\": [\n \"READ\",\n \"OWNER\"\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n }\n ],\n \"attachments\": [\n \"\",\n \"\"\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": null\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"author\": \"\",\n \"last_edited_by\": \"\",\n \"visibility\": \"INTERNAL\",\n \"article_content_download_url\": \"\",\n \"checksum\": \"\",\n \"article_url\": \"\",\n \"status\": \"PUBLISHED\",\n \"type\": \"PAGE\",\n \"remote_created_at\": \"\",\n \"remote_updated_at\": \"\",\n \"parent_article\": \"\",\n \"parent_container\": \"\",\n \"root_container\": \"\",\n \"permissions\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"GROUP\",\n \"roles\": null,\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"USER\",\n \"roles\": null,\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n }\n ],\n \"attachments\": [\n \"\",\n \"\"\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": [\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n },\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-b99342de-7605-4c84-92f7-0b04cfa03ac9" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-369be3c5-041b-436d-81ef-7aebbb71f690" } ], "id": "31039cfe-be01-4d4e-9ce6-289d60b1e16d", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-31039cfe-be01-4d4e-9ce6-289d60b1e16d" }, { "name": "attachments", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve", "id": "d9a021eb-cdb6-4c52-9834-ee83d02e6eaf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/attachments/:id?include_remote_data=&include_shell_data=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "attachments", ":id" ], "query": [ { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" } ], "variable": [ { "id": "b3ad5042-fdda-47e7-b001-05c1944d5e45", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Returns an `Attachment` object with the given `id`." }, "response": [ { "id": "ddb1748b-407b-43d4-ba0b-0fe83805e3c1", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/attachments/:id?include_remote_data=&include_shell_data=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "attachments", ":id" ], "query": [ { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attachment_url\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": [\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n },\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-ddb1748b-407b-43d4-ba0b-0fe83805e3c1" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-d9a021eb-cdb6-4c52-9834-ee83d02e6eaf" } ], "id": "93eef7f6-b984-4e13-a0a8-dbaa0f51c1f0", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-93eef7f6-b984-4e13-a0a8-dbaa0f51c1f0" }, { "name": "List", "id": "d254e30e-d67b-49e8-a93c-6db06d1be5b5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/attachments?created_after=&created_before=&cursor=&include_deleted_data=&include_remote_data=&include_shell_data=&modified_after=&modified_before=&page_size=&remote_id=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "attachments" ], "query": [ { "description": "If provided, will only return objects created after this datetime.", "key": "created_after", "value": "" }, { "description": "If provided, will only return objects created before this datetime.", "key": "created_before", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "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/).", "key": "include_deleted_data", "value": "" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" }, { "description": "If provided, only objects synced by Merge after this date time will be returned.", "key": "modified_after", "value": "" }, { "description": "If provided, only objects synced by Merge before this date time will be returned.", "key": "modified_before", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "The API provider's ID for the given object.", "key": "remote_id", "value": "" } ] }, "description": "Returns a list of `Attachment` objects." }, "response": [ { "id": "2014e917-2c00-4218-9dee-569aa66b6ffe", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/attachments?created_after=&created_before=&cursor=&include_deleted_data=&include_remote_data=&include_shell_data=&modified_after=&modified_before=&page_size=&remote_id=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "attachments" ], "query": [ { "description": "If provided, will only return objects created after this datetime.", "key": "created_after", "value": "" }, { "description": "If provided, will only return objects created before this datetime.", "key": "created_before", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "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/).", "key": "include_deleted_data", "value": "" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" }, { "description": "If provided, only objects synced by Merge after this date time will be returned.", "key": "modified_after", "value": "" }, { "description": "If provided, only objects synced by Merge before this date time will be returned.", "key": "modified_before", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "The API provider's ID for the given object.", "key": "remote_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attachment_url\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": [\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n },\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n }\n ]\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"attachment_url\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": [\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n },\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-2014e917-2c00-4218-9dee-569aa66b6ffe" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-d254e30e-d67b-49e8-a93c-6db06d1be5b5" } ], "id": "88c3ebfa-084d-4c19-9c0d-777e6a969520", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-88c3ebfa-084d-4c19-9c0d-777e6a969520" }, { "name": "containers", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve", "id": "edfafa72-fafc-4e24-9d3a-adf0390fc578", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/containers/:id?expand=parent_article,parent_container&include_remote_data=&include_shell_data=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "containers", ":id" ], "query": [ { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "parent_article,parent_container" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" } ], "variable": [ { "id": "69ecfd90-d568-4315-9a75-7d93268f35e1", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Returns a `Container` object with the given `id`." }, "response": [ { "id": "b235df54-c152-41e5-99f8-f5b3e3949f92", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/containers/:id?expand=parent_article,parent_container&include_remote_data=&include_shell_data=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "containers", ":id" ], "query": [ { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "parent_article,parent_container" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"PUBLISHED\",\n \"container_url\": \"\",\n \"type\": \"SPACE\",\n \"visibility\": \"PUBLIC\",\n \"remote_created_at\": \"\",\n \"remote_updated_at\": \"\",\n \"parent_article\": \"\",\n \"parent_container\": \"\",\n \"permissions\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"USER\",\n \"roles\": null,\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"GROUP\",\n \"roles\": [\n \"WRITE\",\n \"READ\"\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n }\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": [\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n },\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-b235df54-c152-41e5-99f8-f5b3e3949f92" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-edfafa72-fafc-4e24-9d3a-adf0390fc578" } ], "id": "063e327a-f5e1-4289-aca7-3af7e6c6034c", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-063e327a-f5e1-4289-aca7-3af7e6c6034c" }, { "name": "List", "id": "e5a858ec-8525-4eed-9534-c82178230dcb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/containers?created_after=&created_before=&cursor=&expand=permissions,parent_article&include_deleted_data=&include_remote_data=&include_shell_data=&modified_after=&modified_before=&page_size=&parent_article_id=&parent_container_id=&remote_id=&type=FOLDER", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "containers" ], "query": [ { "description": "If provided, will only return objects created after this datetime.", "key": "created_after", "value": "" }, { "description": "If provided, will only return objects created before this datetime.", "key": "created_before", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "permissions,parent_article" }, { "description": "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/).", "key": "include_deleted_data", "value": "" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" }, { "description": "If provided, only objects synced by Merge after this date time will be returned.", "key": "modified_after", "value": "" }, { "description": "If provided, only objects synced by Merge before this date time will be returned.", "key": "modified_before", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "If provided, will only return sub containers of the parent_article_id.", "key": "parent_article_id", "value": "" }, { "description": "If provided, will only return sub containers of the parent_container_id.", "key": "parent_container_id", "value": "" }, { "description": "The API provider's ID for the given object.", "key": "remote_id", "value": "" }, { "description": "If provided, will only return containers of the given type.", "key": "type", "value": "FOLDER" } ] }, "description": "Returns a list of `Container` objects." }, "response": [ { "id": "63bf959c-fd03-4810-ad56-62a9bcb22021", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/containers?created_after=&created_before=&cursor=&expand=permissions,parent_article&include_deleted_data=&include_remote_data=&include_shell_data=&modified_after=&modified_before=&page_size=&parent_article_id=&parent_container_id=&remote_id=&type=FOLDER", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "containers" ], "query": [ { "description": "If provided, will only return objects created after this datetime.", "key": "created_after", "value": "" }, { "description": "If provided, will only return objects created before this datetime.", "key": "created_before", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "permissions,parent_article" }, { "description": "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/).", "key": "include_deleted_data", "value": "" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" }, { "description": "If provided, only objects synced by Merge after this date time will be returned.", "key": "modified_after", "value": "" }, { "description": "If provided, only objects synced by Merge before this date time will be returned.", "key": "modified_before", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "If provided, will only return sub containers of the parent_article_id.", "key": "parent_article_id", "value": "" }, { "description": "If provided, will only return sub containers of the parent_container_id.", "key": "parent_container_id", "value": "" }, { "description": "The API provider's ID for the given object.", "key": "remote_id", "value": "" }, { "description": "If provided, will only return containers of the given type.", "key": "type", "value": "FOLDER" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"DRAFT\",\n \"container_url\": \"\",\n \"type\": \"SECTION\",\n \"visibility\": \"PUBLIC\",\n \"remote_created_at\": \"\",\n \"remote_updated_at\": \"\",\n \"parent_article\": \"\",\n \"parent_container\": \"\",\n \"permissions\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"USER\",\n \"roles\": [\n \"OWNER\",\n \"OWNER\"\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"USER\",\n \"roles\": null,\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n }\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": null\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"status\": \"ARCHIVED\",\n \"container_url\": \"\",\n \"type\": \"COLLECTION\",\n \"visibility\": \"RESTRICTED\",\n \"remote_created_at\": \"\",\n \"remote_updated_at\": \"\",\n \"parent_article\": \"\",\n \"parent_container\": \"\",\n \"permissions\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"ANYONE\",\n \"roles\": [\n \"OWNER\",\n \"OWNER\"\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"user\": \"\",\n \"group\": \"\",\n \"type\": \"ANYONE\",\n \"roles\": null,\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n }\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": [\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n },\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-63bf959c-fd03-4810-ad56-62a9bcb22021" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-e5a858ec-8525-4eed-9534-c82178230dcb" } ], "id": "a510a542-578b-4c5c-9e3e-c633ba7d6c3e", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-a510a542-578b-4c5c-9e3e-c633ba7d6c3e" }, { "name": "groups", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve", "id": "5701de61-6e37-4899-bf87-279b645ac48c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/groups/:id?expand=users,parent_group&include_remote_data=&include_shell_data=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "groups", ":id" ], "query": [ { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "users,parent_group" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" } ], "variable": [ { "id": "dc1ee1dd-0b6c-43df-b1b4-af9cb9d86f93", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Returns a `Group` object with the given `id`." }, "response": [ { "id": "0db51359-5ff1-421e-bdb0-7932ead1be1a", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/groups/:id?expand=users,parent_group&include_remote_data=&include_shell_data=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "groups", ":id" ], "query": [ { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "users,parent_group" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"parent_group\": \"\",\n \"users\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"email_address\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"email_address\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n }\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": [\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n },\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-0db51359-5ff1-421e-bdb0-7932ead1be1a" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-5701de61-6e37-4899-bf87-279b645ac48c" } ], "id": "805551bf-fae9-4348-b7dd-1fd5b683e4d4", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-805551bf-fae9-4348-b7dd-1fd5b683e4d4" }, { "name": "List", "id": "1d749abf-2f4f-4048-894f-586744f17ae2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/groups?created_after=&created_before=&cursor=&expand=users&include_deleted_data=&include_remote_data=&include_shell_data=&modified_after=&modified_before=&page_size=&remote_id=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "groups" ], "query": [ { "description": "If provided, will only return objects created after this datetime.", "key": "created_after", "value": "" }, { "description": "If provided, will only return objects created before this datetime.", "key": "created_before", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "users" }, { "description": "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/).", "key": "include_deleted_data", "value": "" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" }, { "description": "If provided, only objects synced by Merge after this date time will be returned.", "key": "modified_after", "value": "" }, { "description": "If provided, only objects synced by Merge before this date time will be returned.", "key": "modified_before", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "The API provider's ID for the given object.", "key": "remote_id", "value": "" } ] }, "description": "Returns a list of `Group` objects." }, "response": [ { "id": "e081b0d1-fd93-4c9f-8dbf-32488dac819e", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/groups?created_after=&created_before=&cursor=&expand=users&include_deleted_data=&include_remote_data=&include_shell_data=&modified_after=&modified_before=&page_size=&remote_id=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "groups" ], "query": [ { "description": "If provided, will only return objects created after this datetime.", "key": "created_after", "value": "" }, { "description": "If provided, will only return objects created before this datetime.", "key": "created_before", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.", "key": "expand", "value": "users" }, { "description": "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/).", "key": "include_deleted_data", "value": "" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" }, { "description": "If provided, only objects synced by Merge after this date time will be returned.", "key": "modified_after", "value": "" }, { "description": "If provided, only objects synced by Merge before this date time will be returned.", "key": "modified_before", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "The API provider's ID for the given object.", "key": "remote_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"parent_group\": \"\",\n \"users\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"email_address\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"email_address\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n }\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": null\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"parent_group\": \"\",\n \"users\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"email_address\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"email_address\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n }\n ],\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {},\n \"remote_data\": [\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n },\n {\n \"path\": \"\",\n \"data\": {\n \"description\": \"The data returned from the third-party for this object in its original, unnormalized format.\"\n }\n }\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-e081b0d1-fd93-4c9f-8dbf-32488dac819e" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-1d749abf-2f4f-4048-894f-586744f17ae2" } ], "id": "9aad6cee-241a-4e28-bb44-8e231935f2b7", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-9aad6cee-241a-4e28-bb44-8e231935f2b7" }, { "name": "users", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve", "id": "96bcf72c-33ae-4490-ace0-4822b7b32fa4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/users/:id?include_remote_data=&include_shell_data=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "users", ":id" ], "query": [ { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" } ], "variable": [ { "id": "30521d78-59ac-431e-a883-20ac84ae2328", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Returns a `User` object with the given `id`." }, "response": [ { "id": "bd0d28cf-ad65-41bb-a309-337d00d04911", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/users/:id?include_remote_data=&include_shell_data=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "users", ":id" ], "query": [ { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"email_address\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-bd0d28cf-ad65-41bb-a309-337d00d04911" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-96bcf72c-33ae-4490-ace0-4822b7b32fa4" } ], "id": "80ece0b7-a57e-4247-9c15-b777c0a8d4e7", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-80ece0b7-a57e-4247-9c15-b777c0a8d4e7" }, { "name": "List", "id": "a33a1f8c-5577-41c4-bc85-fd898c28fc40", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/users?created_after=&created_before=&cursor=&include_deleted_data=&include_remote_data=&include_shell_data=&modified_after=&modified_before=&page_size=&remote_id=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "users" ], "query": [ { "description": "If provided, will only return objects created after this datetime.", "key": "created_after", "value": "" }, { "description": "If provided, will only return objects created before this datetime.", "key": "created_before", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "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/).", "key": "include_deleted_data", "value": "" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" }, { "description": "If provided, only objects synced by Merge after this date time will be returned.", "key": "modified_after", "value": "" }, { "description": "If provided, only objects synced by Merge before this date time will be returned.", "key": "modified_before", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "The API provider's ID for the given object.", "key": "remote_id", "value": "" } ] }, "description": "Returns a list of `User` objects." }, "response": [ { "id": "22d88448-877a-4d74-bd24-62db47fcb1fe", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/users?created_after=&created_before=&cursor=&include_deleted_data=&include_remote_data=&include_shell_data=&modified_after=&modified_before=&page_size=&remote_id=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "users" ], "query": [ { "description": "If provided, will only return objects created after this datetime.", "key": "created_after", "value": "" }, { "description": "If provided, will only return objects created before this datetime.", "key": "created_before", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "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/).", "key": "include_deleted_data", "value": "" }, { "description": "Whether to include the original data Merge fetched from the third-party to produce these models.", "key": "include_remote_data", "value": "" }, { "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).", "key": "include_shell_data", "value": "" }, { "description": "If provided, only objects synced by Merge after this date time will be returned.", "key": "modified_after", "value": "" }, { "description": "If provided, only objects synced by Merge before this date time will be returned.", "key": "modified_before", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "The API provider's ID for the given object.", "key": "remote_id", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"email_address\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n },\n {\n \"id\": \"\",\n \"remote_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"name\": \"\",\n \"email_address\": \"\",\n \"remote_was_deleted\": \"\",\n \"field_mappings\": {}\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-22d88448-877a-4d74-bd24-62db47fcb1fe" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-a33a1f8c-5577-41c4-bc85-fd898c28fc40" } ], "id": "27e0432e-7754-4df9-b6a7-da8ba2f6ce9e", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-27e0432e-7754-4df9-b6a7-da8ba2f6ce9e" }, { "name": "account-details", "item": [ { "name": "Retrieve", "id": "3f312316-f7a3-4cd9-b13f-aef35c7b9025", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/account-details", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "account-details" ] }, "description": "Get details for a linked account." }, "response": [ { "id": "c6a37458-496e-45ef-8954-c2137e882a36", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/account-details", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "account-details" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"integration\": \"\",\n \"integration_slug\": \"\",\n \"category\": \"filestorage\",\n \"end_user_origin_id\": \"\",\n \"end_user_organization_name\": \"\",\n \"end_user_email_address\": \"\",\n \"status\": \"\",\n \"webhook_listener_url\": \"\",\n \"is_duplicate\": \"\",\n \"account_type\": \"\",\n \"completed_at\": \"\"\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-c6a37458-496e-45ef-8954-c2137e882a36" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-3f312316-f7a3-4cd9-b13f-aef35c7b9025" } ], "id": "6178f5b5-49f7-4b70-b088-0b97a98cf56e", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-6178f5b5-49f7-4b70-b088-0b97a98cf56e" }, { "name": "account-token", "item": [ { "name": "{public_token}", "item": [ { "name": "Retrieve", "id": "b74a29f1-de38-413d-be2e-04e93158cbb0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/account-token/:public_token", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "account-token", ":public_token" ], "variable": [ { "id": "44e410c0-e899-46b8-bcac-7c36a1eac2b0", "key": "public_token", "value": "", "description": "(Required) " } ] }, "description": "Returns the account token for the end user with the provided public token." }, "response": [ { "id": "af94a0ae-36b1-4c39-a4f0-9f58a15cfb82", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/account-token/:public_token", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "account-token", ":public_token" ], "variable": [ { "key": "public_token" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"account_token\": \"\",\n \"integration\": {\n \"name\": \"\",\n \"abbreviated_name\": \"\",\n \"categories\": [\n \"knowledgebase\",\n \"ticketing\"\n ],\n \"image\": \"\",\n \"square_image\": \"\",\n \"color\": \"\",\n \"slug\": \"\",\n \"api_endpoints_to_documentation_urls\": {\n \"do_ab\": {\n \"description\": \"Any type\"\n },\n \"velit_90\": {\n \"description\": \"Any type\"\n }\n },\n \"webhook_setup_guide_url\": \"\",\n \"category_beta_status\": {}\n },\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-af94a0ae-36b1-4c39-a4f0-9f58a15cfb82" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-b74a29f1-de38-413d-be2e-04e93158cbb0" } ], "id": "f84ef486-327f-4206-b2b7-c39bbd7654df", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-f84ef486-327f-4206-b2b7-c39bbd7654df" }, { "name": "regenerate", "item": [ { "name": "Regenerate Create", "id": "20acb0f0-4549-4627-b84c-e7014fdbd0c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/account-token/regenerate", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "account-token", "regenerate" ] }, "description": "Exchange Linked Account account tokens." }, "response": [ { "id": "359689e2-d6b3-473f-b5ae-d5e85d3301f8", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/account-token/regenerate", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "account-token", "regenerate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"linked_account_id\": \"\",\n \"account_token\": \"\"\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-359689e2-d6b3-473f-b5ae-d5e85d3301f8" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-20acb0f0-4549-4627-b84c-e7014fdbd0c0" } ], "id": "c8bfcca0-8cda-479a-a56e-98f88125b041", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-c8bfcca0-8cda-479a-a56e-98f88125b041" } ], "id": "5697801e-4ca1-472f-aeb4-84db3a143333", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-5697801e-4ca1-472f-aeb4-84db3a143333" }, { "name": "delete-account", "item": [ { "name": "Delete", "id": "11bc9662-c6b5-44f6-ab59-418e8cecde9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/delete-account", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "delete-account" ] }, "description": "Delete a linked account." }, "response": [ { "id": "8b4a4f3e-e4cc-4df3-961e-e2b3f3e91a04", "name": "No response body", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/delete-account", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "delete-account" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-8b4a4f3e-e4cc-4df3-961e-e2b3f3e91a04" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-11bc9662-c6b5-44f6-ab59-418e8cecde9b" } ], "id": "77b52fc5-d817-481f-b8c5-f3612cc50255", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-77b52fc5-d817-481f-b8c5-f3612cc50255" }, { "name": "issues", "item": [ { "name": "{id}", "item": [ { "name": "Retrieve", "id": "ba68adac-9b91-4295-9385-317721673519", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/issues/:id", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "issues", ":id" ], "variable": [ { "id": "9a07a7c0-3457-43bf-a9b9-5e9d52ea64a8", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Get a specific issue." }, "response": [ { "id": "04a730f0-ba67-422e-8f42-125efc3b42de", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/issues/:id", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "issues", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error_description\": \"\",\n \"id\": \"\",\n \"status\": \"RESOLVED\",\n \"end_user\": {\n \"cillume\": {\n \"description\": \"Any type\"\n },\n \"Excepteur_5\": {\n \"description\": \"Any type\"\n }\n },\n \"first_incident_time\": \"\",\n \"last_incident_time\": \"\",\n \"is_muted\": \"\",\n \"error_details\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-04a730f0-ba67-422e-8f42-125efc3b42de" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-ba68adac-9b91-4295-9385-317721673519" } ], "id": "9cea238f-4610-4004-8701-4741b47c4664", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-9cea238f-4610-4004-8701-4741b47c4664" }, { "name": "List", "id": "b9989454-30d1-4206-8298-062748cd7fcc", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/issues?account_token=&cursor=&end_date=&end_user_organization_name=&first_incident_time_after=&first_incident_time_before=&include_muted=&integration_name=&last_incident_time_after=&last_incident_time_before=&linked_account_id=&page_size=&start_date=&status=ONGOING", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "issues" ], "query": [ { "key": "account_token", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "If included, will only include issues whose most recent action occurred before this time", "key": "end_date", "value": "" }, { "key": "end_user_organization_name", "value": "" }, { "description": "If provided, will only return issues whose first incident time was after this datetime.", "key": "first_incident_time_after", "value": "" }, { "description": "If provided, will only return issues whose first incident time was before this datetime.", "key": "first_incident_time_before", "value": "" }, { "description": "If true, will include muted issues", "key": "include_muted", "value": "" }, { "key": "integration_name", "value": "" }, { "description": "If provided, will only return issues whose last incident time was after this datetime.", "key": "last_incident_time_after", "value": "" }, { "description": "If provided, will only return issues whose last incident time was before this datetime.", "key": "last_incident_time_before", "value": "" }, { "description": "If provided, will only include issues pertaining to the linked account passed in.", "key": "linked_account_id", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "If included, will only include issues whose most recent action occurred after this time", "key": "start_date", "value": "" }, { "description": "Status of the issue. Options: ('ONGOING', 'RESOLVED')\n\n* `ONGOING` - ONGOING\n* `RESOLVED` - RESOLVED", "key": "status", "value": "ONGOING" } ] }, "description": "Gets all issues for Organization." }, "response": [ { "id": "319ea614-053c-462f-a5d3-3f4e17b4ab38", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/issues?account_token=&cursor=&end_date=&end_user_organization_name=&first_incident_time_after=&first_incident_time_before=&include_muted=&integration_name=&last_incident_time_after=&last_incident_time_before=&linked_account_id=&page_size=&start_date=&status=ONGOING", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "issues" ], "query": [ { "key": "account_token", "value": "" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "If included, will only include issues whose most recent action occurred before this time", "key": "end_date", "value": "" }, { "key": "end_user_organization_name", "value": "" }, { "description": "If provided, will only return issues whose first incident time was after this datetime.", "key": "first_incident_time_after", "value": "" }, { "description": "If provided, will only return issues whose first incident time was before this datetime.", "key": "first_incident_time_before", "value": "" }, { "description": "If true, will include muted issues", "key": "include_muted", "value": "" }, { "key": "integration_name", "value": "" }, { "description": "If provided, will only return issues whose last incident time was after this datetime.", "key": "last_incident_time_after", "value": "" }, { "description": "If provided, will only return issues whose last incident time was before this datetime.", "key": "last_incident_time_before", "value": "" }, { "description": "If provided, will only include issues pertaining to the linked account passed in.", "key": "linked_account_id", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "If included, will only include issues whose most recent action occurred after this time", "key": "start_date", "value": "" }, { "description": "Status of the issue. Options: ('ONGOING', 'RESOLVED')\n\n* `ONGOING` - ONGOING\n* `RESOLVED` - RESOLVED", "key": "status", "value": "ONGOING" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"error_description\": \"\",\n \"id\": \"\",\n \"status\": \"ONGOING\",\n \"end_user\": {\n \"ut_b\": {\n \"description\": \"Any type\"\n }\n },\n \"first_incident_time\": \"\",\n \"last_incident_time\": \"\",\n \"is_muted\": \"\",\n \"error_details\": [\n \"\",\n \"\"\n ]\n },\n {\n \"error_description\": \"\",\n \"id\": \"\",\n \"status\": \"ONGOING\",\n \"end_user\": {\n \"cupidatat_5\": {\n \"description\": \"Any type\"\n }\n },\n \"first_incident_time\": \"\",\n \"last_incident_time\": \"\",\n \"is_muted\": \"\",\n \"error_details\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-319ea614-053c-462f-a5d3-3f4e17b4ab38" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-b9989454-30d1-4206-8298-062748cd7fcc" } ], "id": "44e48735-a693-4b97-8ceb-1c7c1814a11f", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-44e48735-a693-4b97-8ceb-1c7c1814a11f" }, { "name": "linked-accounts", "item": [ { "name": "List", "id": "fc62a7e5-68bd-4d2a-ab3f-d19fdcd1f78a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/linked-accounts?category=knowledgebase&cursor=&end_user_email_address=&end_user_organization_name=&end_user_origin_id=&end_user_origin_ids=&id=&ids=&include_duplicates=&integration_name=&is_test_account=&page_size=&status=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "linked-accounts" ], "query": [ { "description": "Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing`\n\n* `hris` - hris\n* `ats` - ats\n* `accounting` - accounting\n* `ticketing` - ticketing\n* `crm` - crm\n* `mktg` - mktg\n* `filestorage` - filestorage\n* `datawarehouse` - datawarehouse\n* `knowledgebase` - knowledgebase\n* `communication` - communication\n* `chat` - chat", "key": "category", "value": "knowledgebase" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "If provided, will only return linked accounts associated with the given email address.", "key": "end_user_email_address", "value": "" }, { "description": "If provided, will only return linked accounts associated with the given organization name.", "key": "end_user_organization_name", "value": "" }, { "description": "If provided, will only return linked accounts associated with the given origin ID.", "key": "end_user_origin_id", "value": "" }, { "description": "Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.", "key": "end_user_origin_ids", "value": "" }, { "key": "id", "value": "" }, { "description": "Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.", "key": "ids", "value": "" }, { "description": "If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.", "key": "include_duplicates", "value": "" }, { "description": "If provided, will only return linked accounts associated with the given integration name.", "key": "integration_name", "value": "" }, { "description": "If included, will only include test linked accounts. If not included, will only include non-test linked accounts.", "key": "is_test_account", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`", "key": "status", "value": "" } ] }, "description": "List linked accounts for your organization." }, "response": [ { "id": "583c7560-9063-40d0-b8d3-33140160f99b", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/linked-accounts?category=knowledgebase&cursor=&end_user_email_address=&end_user_organization_name=&end_user_origin_id=&end_user_origin_ids=&id=&ids=&include_duplicates=&integration_name=&is_test_account=&page_size=&status=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "linked-accounts" ], "query": [ { "description": "Options: `accounting`, `ats`, `crm`, `filestorage`, `hris`, `knowledgebase`, `mktg`, `ticketing`\n\n* `hris` - hris\n* `ats` - ats\n* `accounting` - accounting\n* `ticketing` - ticketing\n* `crm` - crm\n* `mktg` - mktg\n* `filestorage` - filestorage\n* `datawarehouse` - datawarehouse\n* `knowledgebase` - knowledgebase\n* `communication` - communication\n* `chat` - chat", "key": "category", "value": "knowledgebase" }, { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "If provided, will only return linked accounts associated with the given email address.", "key": "end_user_email_address", "value": "" }, { "description": "If provided, will only return linked accounts associated with the given organization name.", "key": "end_user_organization_name", "value": "" }, { "description": "If provided, will only return linked accounts associated with the given origin ID.", "key": "end_user_origin_id", "value": "" }, { "description": "Comma-separated list of EndUser origin IDs, making it possible to specify multiple EndUsers at once.", "key": "end_user_origin_ids", "value": "" }, { "key": "id", "value": "" }, { "description": "Comma-separated list of LinkedAccount IDs, making it possible to specify multiple LinkedAccounts at once.", "key": "ids", "value": "" }, { "description": "If `true`, will include complete production duplicates of the account specified by the `id` query parameter in the response. `id` must be for a complete production linked account.", "key": "include_duplicates", "value": "" }, { "description": "If provided, will only return linked accounts associated with the given integration name.", "key": "integration_name", "value": "" }, { "description": "If included, will only include test linked accounts. If not included, will only include non-test linked accounts.", "key": "is_test_account", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "Filter by status. Options: `COMPLETE`, `IDLE`, `INCOMPLETE`, `RELINK_NEEDED`", "key": "status", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"id\": \"\",\n \"status\": \"IDLE\",\n \"end_user_organization_name\": \"\",\n \"end_user_email_address\": \"\",\n \"webhook_listener_url\": \"\",\n \"account_type\": \"\",\n \"completed_at\": \"\",\n \"category\": \"ats\",\n \"status_detail\": \"\",\n \"end_user_origin_id\": \"\",\n \"subdomain\": \"\",\n \"is_duplicate\": \"\",\n \"integration\": {\n \"name\": \"\",\n \"categories\": [\n \"hris\",\n \"knowledgebase\"\n ],\n \"color\": \"\",\n \"slug\": \"\",\n \"passthrough_available\": \"\",\n \"image\": \"\",\n \"square_image\": \"\",\n \"available_model_operations\": [\n {\n \"model_name\": \"\",\n \"available_operations\": [\n \"\",\n \"\"\n ],\n \"required_post_parameters\": [\n \"\",\n \"\"\n ],\n \"supported_fields\": [\n \"\",\n \"\"\n ]\n },\n {\n \"model_name\": \"\",\n \"available_operations\": [\n \"\",\n \"\"\n ],\n \"required_post_parameters\": [\n \"\",\n \"\"\n ],\n \"supported_fields\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"integration_specific_fields\": {\n \"anim_f\": {\n \"description\": \"Any type\"\n }\n }\n },\n {\n \"id\": \"\",\n \"status\": \"COMPLETE\",\n \"end_user_organization_name\": \"\",\n \"end_user_email_address\": \"\",\n \"webhook_listener_url\": \"\",\n \"account_type\": \"\",\n \"completed_at\": \"\",\n \"category\": \"accounting\",\n \"status_detail\": \"\",\n \"end_user_origin_id\": \"\",\n \"subdomain\": \"\",\n \"is_duplicate\": \"\",\n \"integration\": {\n \"name\": \"\",\n \"categories\": [\n \"ats\",\n \"knowledgebase\"\n ],\n \"color\": \"\",\n \"slug\": \"\",\n \"passthrough_available\": \"\",\n \"image\": \"\",\n \"square_image\": \"\",\n \"available_model_operations\": [\n {\n \"model_name\": \"\",\n \"available_operations\": [\n \"\",\n \"\"\n ],\n \"required_post_parameters\": [\n \"\",\n \"\"\n ],\n \"supported_fields\": [\n \"\",\n \"\"\n ]\n },\n {\n \"model_name\": \"\",\n \"available_operations\": [\n \"\",\n \"\"\n ],\n \"required_post_parameters\": [\n \"\",\n \"\"\n ],\n \"supported_fields\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n \"integration_specific_fields\": {\n \"et6\": {\n \"description\": \"Any type\"\n },\n \"utc8\": {\n \"description\": \"Any type\"\n }\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-583c7560-9063-40d0-b8d3-33140160f99b" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-fc62a7e5-68bd-4d2a-ab3f-d19fdcd1f78a" } ], "id": "f1ff4190-eb2a-4275-8dc8-5cd1c5c76d75", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-f1ff4190-eb2a-4275-8dc8-5cd1c5c76d75" }, { "name": "link-token", "item": [ { "name": "Create", "id": "4416d7c1-fbff-43f9-b90b-e3e0cbcdc577", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"end_user_email_address\": \"\",\n \"end_user_organization_name\": \"\",\n \"end_user_origin_id\": \"\",\n \"categories\": [\n \"crm\",\n \"filestorage\"\n ],\n \"integration\": \"\",\n \"link_expiry_mins\": 30,\n \"should_create_magic_link_url\": false,\n \"hide_admin_magic_link\": false,\n \"common_models\": null,\n \"category_common_model_scopes\": null,\n \"language\": \"en\",\n \"are_syncs_disabled\": false,\n \"integration_specific_config\": {\n \"consequat6\": {\n \"description\": \"Any type\"\n }\n },\n \"completed_account_initial_screen\": \"SELECTIVE_SYNC\",\n \"linked_destination_id\": \"\",\n \"credential_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/link-token", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "link-token" ] }, "description": "Creates a link token to be used when linking a new end user." }, "response": [ { "id": "e4a99ca0-408d-4f61-bfa3-57f2c3315ce7", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"end_user_email_address\": \"\",\n \"end_user_organization_name\": \"\",\n \"end_user_origin_id\": \"\",\n \"categories\": [\n \"crm\",\n \"filestorage\"\n ],\n \"integration\": \"\",\n \"link_expiry_mins\": 30,\n \"should_create_magic_link_url\": false,\n \"hide_admin_magic_link\": false,\n \"common_models\": null,\n \"category_common_model_scopes\": null,\n \"language\": \"en\",\n \"are_syncs_disabled\": false,\n \"integration_specific_config\": {\n \"consequat6\": {\n \"description\": \"Any type\"\n }\n },\n \"completed_account_initial_screen\": \"SELECTIVE_SYNC\",\n \"linked_destination_id\": \"\",\n \"credential_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/link-token", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "link-token" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"link_token\": \"\",\n \"integration_name\": \"\",\n \"magic_link_url\": \"\"\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-e4a99ca0-408d-4f61-bfa3-57f2c3315ce7" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-4416d7c1-fbff-43f9-b90b-e3e0cbcdc577" } ], "id": "178ee0ec-1978-4a9d-949c-e1e27405952b", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-178ee0ec-1978-4a9d-949c-e1e27405952b" }, { "name": "field-mappings", "item": [ { "name": "{field_mapping_id}", "item": [ { "name": "Field Mappings Destroy", "id": "4d5157eb-19e7-4f3b-9bbc-a63492a678e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/field-mappings/:field_mapping_id", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "field-mappings", ":field_mapping_id" ], "variable": [ { "id": "cb66efca-ab0b-4c48-8bf7-4fae53f2c4a6", "key": "field_mapping_id", "value": "", "description": "(Required) " } ] }, "description": "Deletes Field Mappings for a Linked Account. All data related to this Field Mapping will be deleted and these changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start." }, "response": [ { "id": "98e9d5d3-0cdb-413e-8194-ca06c71a9923", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/field-mappings/:field_mapping_id", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "field-mappings", ":field_mapping_id" ], "variable": [ { "key": "field_mapping_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"model\": {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": null,\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": null\n }\n },\n \"jmes_path\": \"\"\n },\n \"warnings\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n }\n ],\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n }\n ],\n \"logs\": [\n {\n \"log_id\": \"\",\n \"dashboard_view\": \"\",\n \"log_summary\": {\n \"url\": \"\",\n \"method\": \"\",\n \"status_code\": \"\"\n }\n },\n {\n \"log_id\": \"\",\n \"dashboard_view\": \"\",\n \"log_summary\": {\n \"url\": \"\",\n \"method\": \"\",\n \"status_code\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-98e9d5d3-0cdb-413e-8194-ca06c71a9923" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-4d5157eb-19e7-4f3b-9bbc-a63492a678e1" }, { "name": "Field Mappings Partial Update", "id": "226406ce-eafe-4b4e-ab2a-d213dabcc937", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"remote_field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"remote_method\": \"\",\n \"remote_url_path\": \"\",\n \"jmes_path\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/field-mappings/:field_mapping_id", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "field-mappings", ":field_mapping_id" ], "variable": [ { "id": "bd4c23fe-d64d-4e72-a553-7beb663f30da", "key": "field_mapping_id", "value": "", "description": "(Required) " } ] }, "description": "Create or update existing Field Mappings for a Linked Account. Changes will be reflected after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start." }, "response": [ { "id": "dc49608f-2d8a-4581-87c8-df723149afd9", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"remote_field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"remote_method\": \"\",\n \"remote_url_path\": \"\",\n \"jmes_path\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/field-mappings/:field_mapping_id", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "field-mappings", ":field_mapping_id" ], "variable": [ { "key": "field_mapping_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"model\": {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": null,\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": null\n }\n },\n \"jmes_path\": \"\"\n },\n \"warnings\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n }\n ],\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n }\n ],\n \"logs\": [\n {\n \"log_id\": \"\",\n \"dashboard_view\": \"\",\n \"log_summary\": {\n \"url\": \"\",\n \"method\": \"\",\n \"status_code\": \"\"\n }\n },\n {\n \"log_id\": \"\",\n \"dashboard_view\": \"\",\n \"log_summary\": {\n \"url\": \"\",\n \"method\": \"\",\n \"status_code\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-dc49608f-2d8a-4581-87c8-df723149afd9" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-226406ce-eafe-4b4e-ab2a-d213dabcc937" } ], "id": "ba7ed488-ab98-4a30-9c90-0e0653c26818", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-ba7ed488-ab98-4a30-9c90-0e0653c26818" }, { "name": "Field Mappings Retrieve", "id": "34b285ba-2de0-4aa1-8ff8-8de8838708fb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/field-mappings?exclude_remote_field_metadata=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "field-mappings" ], "query": [ { "description": "If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.", "key": "exclude_remote_field_metadata", "value": "" } ] }, "description": "Get all Field Mappings for this Linked Account. Field Mappings are mappings between third-party Remote Fields and user defined Merge fields. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/)." }, "response": [ { "id": "ed5d0e93-0bca-4d31-a629-1884f0456520", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/field-mappings?exclude_remote_field_metadata=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "field-mappings" ], "query": [ { "description": "If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.", "key": "exclude_remote_field_metadata", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"Container\": [\n {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": {\n \"nulla_f\": {\n \"description\": \"Any type\"\n },\n \"cupidatat_9\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": null\n }\n },\n \"jmes_path\": \"\"\n },\n {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": null,\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n \"\",\n \"\"\n ]\n }\n },\n \"jmes_path\": \"\"\n }\n ],\n \"Article\": [\n {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": {\n \"Lorem_a\": {\n \"description\": \"Any type\"\n },\n \"do_d1\": {\n \"description\": \"Any type\"\n },\n \"reprehenderit7c2\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n \"\",\n \"\"\n ]\n }\n },\n \"jmes_path\": \"\"\n },\n {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": null,\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": null\n }\n },\n \"jmes_path\": \"\"\n }\n ],\n \"Attachment\": [\n {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": null,\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": null\n }\n },\n \"jmes_path\": \"\"\n },\n {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": {\n \"ipsum_\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": null\n }\n },\n \"jmes_path\": \"\"\n }\n ],\n \"User\": [\n {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": {\n \"adipisicing_50\": {\n \"description\": \"Any type\"\n },\n \"non24\": {\n \"description\": \"Any type\"\n },\n \"quis_abc\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n \"\",\n \"\"\n ]\n }\n },\n \"jmes_path\": \"\"\n },\n {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": {\n \"etf9\": {\n \"description\": \"Any type\"\n },\n \"nisi_4\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n \"\",\n \"\"\n ]\n }\n },\n \"jmes_path\": \"\"\n }\n ],\n \"Group\": [\n {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": {\n \"ea_a\": {\n \"description\": \"Any type\"\n },\n \"sitbfb\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": null\n }\n },\n \"jmes_path\": \"\"\n },\n {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": null,\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": null\n }\n },\n \"jmes_path\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-ed5d0e93-0bca-4d31-a629-1884f0456520" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-34b285ba-2de0-4aa1-8ff8-8de8838708fb" }, { "name": "Field Mappings Create", "id": "93bd7717-9ca0-44a7-81fc-7b3c4925a0da", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"target_field_name\": \"\",\n \"target_field_description\": \"\",\n \"remote_field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"remote_method\": \"\",\n \"remote_url_path\": \"\",\n \"common_model_name\": \"\",\n \"jmes_path\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/field-mappings?exclude_remote_field_metadata=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "field-mappings" ], "query": [ { "description": "If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.", "key": "exclude_remote_field_metadata", "value": "" } ] }, "description": "Create new Field Mappings that will be available after the next scheduled sync. This will cause the next sync for this Linked Account to sync **ALL** data from start." }, "response": [ { "id": "535c5a26-fecd-4684-b56d-9131f9a09afe", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"target_field_name\": \"\",\n \"target_field_description\": \"\",\n \"remote_field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"remote_method\": \"\",\n \"remote_url_path\": \"\",\n \"common_model_name\": \"\",\n \"jmes_path\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/field-mappings?exclude_remote_field_metadata=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "field-mappings" ], "query": [ { "description": "If `true`, remote fields metadata is excluded from each field mapping instance (i.e. `remote_fields.remote_key_name` and `remote_fields.schema` will be null). This will increase the speed of the request since these fields require some calculations.", "key": "exclude_remote_field_metadata", "value": "" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"model\": {\n \"id\": \"\",\n \"is_integration_wide\": \"\",\n \"target_field\": {\n \"name\": \"\",\n \"description\": \"\",\n \"is_organization_wide\": \"\"\n },\n \"remote_field\": {\n \"remote_key_name\": \"\",\n \"schema\": null,\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": null\n }\n },\n \"jmes_path\": \"\"\n },\n \"warnings\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n }\n ],\n \"errors\": [\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n },\n {\n \"title\": \"\",\n \"detail\": \"\",\n \"problem_type\": \"\",\n \"source\": {\n \"pointer\": \"\"\n },\n \"block_merge_link\": \"\"\n }\n ],\n \"logs\": [\n {\n \"log_id\": \"\",\n \"dashboard_view\": \"\",\n \"log_summary\": {\n \"url\": \"\",\n \"method\": \"\",\n \"status_code\": \"\"\n }\n },\n {\n \"log_id\": \"\",\n \"dashboard_view\": \"\",\n \"log_summary\": {\n \"url\": \"\",\n \"method\": \"\",\n \"status_code\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-535c5a26-fecd-4684-b56d-9131f9a09afe" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-93bd7717-9ca0-44a7-81fc-7b3c4925a0da" } ], "id": "be5de0c8-f843-4fa4-a591-1d1329a9df10", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-be5de0c8-f843-4fa4-a591-1d1329a9df10" }, { "name": "remote-fields", "item": [ { "name": "Remote Fields Retrieve", "id": "8e590fdc-7b82-4e12-81fb-cf6ad7ed1dc0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/remote-fields?common_models=&include_example_values=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "remote-fields" ], "query": [ { "description": "A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.", "key": "common_models", "value": "" }, { "description": "If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.", "key": "include_example_values", "value": "" } ] }, "description": "Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/overview/)." }, "response": [ { "id": "139515e6-91f4-4610-a497-5824b258eb0c", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/remote-fields?common_models=&include_example_values=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "remote-fields" ], "query": [ { "description": "A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.", "key": "common_models", "value": "" }, { "description": "If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.", "key": "include_example_values", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"Container\": [\n {\n \"schema\": {\n \"cillumdf\": {\n \"description\": \"Any type\"\n },\n \"in_ba5\": {\n \"description\": \"Any type\"\n },\n \"velit9\": {\n \"description\": \"Any type\"\n },\n \"sit_6e\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_key_name\": \"\",\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"advanced_metadata\": {\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_custom\": \"\",\n \"field_choices\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"example_values\": null,\n \"coverage\": \"\"\n },\n {\n \"schema\": {\n \"sit2\": {\n \"description\": \"Any type\"\n },\n \"dolorf\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_key_name\": \"\",\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"advanced_metadata\": {\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_custom\": \"\",\n \"field_choices\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"example_values\": null,\n \"coverage\": \"\"\n }\n ],\n \"Article\": [\n {\n \"schema\": {\n \"esse_bdd\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_key_name\": \"\",\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"advanced_metadata\": {\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_custom\": \"\",\n \"field_choices\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"example_values\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"coverage\": \"\"\n },\n {\n \"schema\": {\n \"occaecat_a\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_key_name\": \"\",\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"advanced_metadata\": {\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_custom\": \"\",\n \"field_choices\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"example_values\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"coverage\": \"\"\n }\n ],\n \"Attachment\": [\n {\n \"schema\": {\n \"dolor_5\": {\n \"description\": \"Any type\"\n },\n \"veniam9__\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_key_name\": \"\",\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"advanced_metadata\": {\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_custom\": \"\",\n \"field_choices\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"example_values\": null,\n \"coverage\": \"\"\n },\n {\n \"schema\": {\n \"in_7\": {\n \"description\": \"Any type\"\n },\n \"velit_3d\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_key_name\": \"\",\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"advanced_metadata\": {\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_custom\": \"\",\n \"field_choices\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"example_values\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"coverage\": \"\"\n }\n ],\n \"User\": [\n {\n \"schema\": {\n \"nulla_fe\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_key_name\": \"\",\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"advanced_metadata\": {\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_custom\": \"\",\n \"field_choices\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"example_values\": null,\n \"coverage\": \"\"\n },\n {\n \"schema\": {\n \"nulla_\": {\n \"description\": \"Any type\"\n },\n \"cupidatatde\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_key_name\": \"\",\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"advanced_metadata\": {\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_custom\": \"\",\n \"field_choices\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"example_values\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"coverage\": \"\"\n }\n ],\n \"Group\": [\n {\n \"schema\": {\n \"sunt_66\": {\n \"description\": \"Any type\"\n },\n \"occaecatf\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_key_name\": \"\",\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"advanced_metadata\": {\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_custom\": \"\",\n \"field_choices\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"example_values\": null,\n \"coverage\": \"\"\n },\n {\n \"schema\": {\n \"proident_b\": {\n \"description\": \"Any type\"\n }\n },\n \"remote_key_name\": \"\",\n \"remote_endpoint_info\": {\n \"method\": \"\",\n \"url_path\": \"\",\n \"field_traversal_path\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"advanced_metadata\": {\n \"id\": \"\",\n \"display_name\": \"\",\n \"description\": \"\",\n \"is_required\": \"\",\n \"is_custom\": \"\",\n \"field_choices\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n },\n \"example_values\": null,\n \"coverage\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-139515e6-91f4-4610-a497-5824b258eb0c" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-8e590fdc-7b82-4e12-81fb-cf6ad7ed1dc0" } ], "id": "26cc1a45-1946-48ee-8204-0dc223f0b8d2", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-26cc1a45-1946-48ee-8204-0dc223f0b8d2" }, { "name": "target-fields", "item": [ { "name": "Target Fields Retrieve", "id": "24951a9a-e9b1-4fee-942c-4e24cddb3c39", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/target-fields", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "target-fields" ] }, "description": "Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/)." }, "response": [ { "id": "418f0fb0-a2aa-4196-b2ef-bd38d1f98775", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/target-fields", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "target-fields" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"Container\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"is_mapped\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"is_mapped\": \"\"\n }\n ],\n \"Article\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"is_mapped\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"is_mapped\": \"\"\n }\n ],\n \"Attachment\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"is_mapped\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"is_mapped\": \"\"\n }\n ],\n \"User\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"is_mapped\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"is_mapped\": \"\"\n }\n ],\n \"Group\": [\n {\n \"name\": \"\",\n \"description\": \"\",\n \"is_mapped\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\",\n \"is_mapped\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-418f0fb0-a2aa-4196-b2ef-bd38d1f98775" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-24951a9a-e9b1-4fee-942c-4e24cddb3c39" } ], "id": "be088549-1014-4ab9-a2a1-bd17c4911e5a", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-be088549-1014-4ab9-a2a1-bd17c4911e5a" }, { "name": "default-scopes", "item": [ { "name": "Default Scopes Retrieve", "id": "63ea1ea0-0564-46bc-9ffb-036e844913d2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/default-scopes", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "default-scopes" ] }, "description": "Get the default permissions for Merge Common Models and fields across all Linked Accounts of a given category. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)." }, "response": [ { "id": "b3318ec9-b145-4fd3-98a1-a10cbaf1bcc7", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/default-scopes", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "default-scopes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"common_models\": [\n {\n \"model_name\": \"\",\n \"model_permissions\": {\n \"proidente\": {\n \"is_enabled\": \"\"\n }\n },\n \"field_permissions\": {\n \"enabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"disabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n }\n },\n {\n \"model_name\": \"\",\n \"model_permissions\": {\n \"ullamco_11\": {\n \"is_enabled\": \"\"\n },\n \"consectetur_7\": {\n \"is_enabled\": \"\"\n }\n },\n \"field_permissions\": {\n \"enabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"disabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-b3318ec9-b145-4fd3-98a1-a10cbaf1bcc7" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-63ea1ea0-0564-46bc-9ffb-036e844913d2" } ], "id": "523b7df3-196b-480e-b07d-8574aa2b15fb", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-523b7df3-196b-480e-b07d-8574aa2b15fb" }, { "name": "linked-account-scopes", "item": [ { "name": "Linked Account Scopes Retrieve", "id": "c1b57788-a055-444b-bcef-4b71419f3138", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/linked-account-scopes", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "linked-account-scopes" ] }, "description": "Get all available permissions for Merge Common Models and fields for a single Linked Account. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)." }, "response": [ { "id": "14fdfad8-62bd-45bc-b0e1-083428c646ee", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/linked-account-scopes", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "linked-account-scopes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"common_models\": [\n {\n \"model_name\": \"\",\n \"model_permissions\": {\n \"proidente\": {\n \"is_enabled\": \"\"\n }\n },\n \"field_permissions\": {\n \"enabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"disabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n }\n },\n {\n \"model_name\": \"\",\n \"model_permissions\": {\n \"ullamco_11\": {\n \"is_enabled\": \"\"\n },\n \"consectetur_7\": {\n \"is_enabled\": \"\"\n }\n },\n \"field_permissions\": {\n \"enabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"disabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-14fdfad8-62bd-45bc-b0e1-083428c646ee" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-c1b57788-a055-444b-bcef-4b71419f3138" }, { "name": "Linked Account Scopes Create", "id": "8c408d77-4cd7-464f-83ab-28923149f675", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"common_models\": [\n {\n \"model_name\": \"\",\n \"model_permissions\": {\n \"voluptate403\": {\n \"is_enabled\": \"\"\n },\n \"ad_30\": {\n \"is_enabled\": \"\"\n }\n },\n \"field_permissions\": {\n \"enabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"disabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n }\n },\n {\n \"model_name\": \"\",\n \"model_permissions\": {\n \"estdf7\": {\n \"is_enabled\": \"\"\n }\n },\n \"field_permissions\": {\n \"enabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"disabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/linked-account-scopes", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "linked-account-scopes" ] }, "description": "Update permissions for any Common Model or field for a single Linked Account. Any Scopes not set in this POST request will inherit the default Scopes. [Learn more](https://help.merge.dev/en/articles/5950052-common-model-and-field-scopes)" }, "response": [ { "id": "530988b5-5424-4099-b820-0d334952fac7", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"common_models\": [\n {\n \"model_name\": \"\",\n \"model_permissions\": {\n \"voluptate403\": {\n \"is_enabled\": \"\"\n },\n \"ad_30\": {\n \"is_enabled\": \"\"\n }\n },\n \"field_permissions\": {\n \"enabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"disabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n }\n },\n {\n \"model_name\": \"\",\n \"model_permissions\": {\n \"estdf7\": {\n \"is_enabled\": \"\"\n }\n },\n \"field_permissions\": {\n \"enabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"disabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/linked-account-scopes", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "linked-account-scopes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"common_models\": [\n {\n \"model_name\": \"\",\n \"model_permissions\": {\n \"proidente\": {\n \"is_enabled\": \"\"\n }\n },\n \"field_permissions\": {\n \"enabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"disabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n }\n },\n {\n \"model_name\": \"\",\n \"model_permissions\": {\n \"ullamco_11\": {\n \"is_enabled\": \"\"\n },\n \"consectetur_7\": {\n \"is_enabled\": \"\"\n }\n },\n \"field_permissions\": {\n \"enabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ],\n \"disabled_fields\": [\n {\n \"description\": \"Any type\"\n },\n {\n \"description\": \"Any type\"\n }\n ]\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-530988b5-5424-4099-b820-0d334952fac7" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-8c408d77-4cd7-464f-83ab-28923149f675" } ], "id": "8522610d-338c-4bc7-bfca-d1bf3d45af2e", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-8522610d-338c-4bc7-bfca-d1bf3d45af2e" }, { "name": "sync-status", "item": [ { "name": "resync", "item": [ { "name": "Sync Status Resync Create", "id": "728bc632-0959-43ca-8db2-9a49ad215072", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/sync-status/resync", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "sync-status", "resync" ] }, "description": "Force re-sync of all models. This endpoint is available for monthly, quarterly, and highest sync frequency customers on the Professional or Enterprise plans. Doing so will consume a sync credit for the relevant linked account. Force re-syncs can also be triggered manually in the Merge Dashboard and is available for all customers." }, "response": [ { "id": "17532f9f-4a3e-40ec-99cf-dfb9e785fa11", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/sync-status/resync", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "sync-status", "resync" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"model_name\": \"\",\n \"model_id\": \"\",\n \"status\": \"FAILED\",\n \"is_initial_sync\": \"\",\n \"last_sync_start\": \"\",\n \"next_sync_start\": \"\",\n \"last_sync_result\": \"DISABLED\",\n \"last_sync_finished\": \"\",\n \"selective_sync_configurations_usage\": \"IN_NEXT_SYNC\"\n },\n {\n \"model_name\": \"\",\n \"model_id\": \"\",\n \"status\": \"PAUSED\",\n \"is_initial_sync\": \"\",\n \"last_sync_start\": \"\",\n \"next_sync_start\": \"\",\n \"last_sync_result\": \"FAILED\",\n \"last_sync_finished\": \"\",\n \"selective_sync_configurations_usage\": \"IN_NEXT_SYNC\"\n }\n]", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-17532f9f-4a3e-40ec-99cf-dfb9e785fa11" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-728bc632-0959-43ca-8db2-9a49ad215072" } ], "id": "f8d90195-31dd-415e-901e-0df0995d01ac", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-f8d90195-31dd-415e-901e-0df0995d01ac" }, { "name": "List", "id": "7cf1a043-e658-4d71-9829-8c066a79fde7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/sync-status?cursor=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "sync-status" ], "query": [ { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" } ] }, "description": "Get sync status for the current sync and the most recently finished sync. `last_sync_start` represents the most recent time any sync began. `last_sync_finished` represents the most recent time any sync completed. These timestamps may correspond to different sync instances which may result in a sync start time being later than a separate sync completed time. To ensure you are retrieving the latest available data reference the `last_sync_finished` timestamp where `last_sync_result` is `DONE`. Possible values for `status` and `last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`, `PAUSED`, `SYNCING`. Learn more about sync status in our [Help Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses)." }, "response": [ { "id": "8c25c6b7-5863-4c44-acc5-2e29940f5124", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/sync-status?cursor=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "sync-status" ], "query": [ { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"model_name\": \"\",\n \"model_id\": \"\",\n \"status\": \"PARTIALLY_SYNCED\",\n \"is_initial_sync\": \"\",\n \"last_sync_start\": \"\",\n \"next_sync_start\": \"\",\n \"last_sync_result\": \"DONE\",\n \"last_sync_finished\": \"\",\n \"selective_sync_configurations_usage\": \"IN_LAST_SYNC\"\n },\n {\n \"model_name\": \"\",\n \"model_id\": \"\",\n \"status\": \"PAUSED\",\n \"is_initial_sync\": \"\",\n \"last_sync_start\": \"\",\n \"next_sync_start\": \"\",\n \"last_sync_result\": \"PARTIALLY_SYNCED\",\n \"last_sync_finished\": \"\",\n \"selective_sync_configurations_usage\": \"IN_NEXT_SYNC\"\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-8c25c6b7-5863-4c44-acc5-2e29940f5124" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-7cf1a043-e658-4d71-9829-8c066a79fde7" } ], "id": "02b2147a-1fec-441b-9436-43ae33730bb7", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-02b2147a-1fec-441b-9436-43ae33730bb7" }, { "name": "passthrough", "item": [ { "name": "Create", "id": "84d4e5a9-9e64-48dc-b567-d9a87f49ee96", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"HEAD\",\n \"path\": \"\",\n \"base_url_override\": \"\",\n \"data\": \"\",\n \"multipart_form_data\": [\n {\n \"name\": \"\",\n \"data\": \"\",\n \"encoding\": \"GZIP_BASE64\",\n \"file_name\": \"\",\n \"content_type\": \"\"\n },\n {\n \"name\": \"\",\n \"data\": \"\",\n \"encoding\": \"GZIP_BASE64\",\n \"file_name\": \"\",\n \"content_type\": \"\"\n }\n ],\n \"headers\": {\n \"reprehenderit_50c\": {\n \"description\": \"Any type\"\n },\n \"sunt6\": {\n \"description\": \"Any type\"\n }\n },\n \"request_format\": \"JSON\",\n \"normalize_response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/passthrough", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "passthrough" ] }, "description": "Pull data from an endpoint not currently supported by Merge." }, "response": [ { "id": "7312c8ca-441b-435c-aaaf-5ac92a7d84ad", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"HEAD\",\n \"path\": \"\",\n \"base_url_override\": \"\",\n \"data\": \"\",\n \"multipart_form_data\": [\n {\n \"name\": \"\",\n \"data\": \"\",\n \"encoding\": \"GZIP_BASE64\",\n \"file_name\": \"\",\n \"content_type\": \"\"\n },\n {\n \"name\": \"\",\n \"data\": \"\",\n \"encoding\": \"GZIP_BASE64\",\n \"file_name\": \"\",\n \"content_type\": \"\"\n }\n ],\n \"headers\": {\n \"reprehenderit_50c\": {\n \"description\": \"Any type\"\n },\n \"sunt6\": {\n \"description\": \"Any type\"\n }\n },\n \"request_format\": \"JSON\",\n \"normalize_response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/passthrough", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "passthrough" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"method\": \"\",\n \"path\": \"\",\n \"status\": \"\",\n \"response\": {\n \"description\": \"Any type\"\n },\n \"response_headers\": {\n \"laboris9dd\": {\n \"description\": \"Any type\"\n }\n },\n \"response_type\": \"BASE64_GZIP\",\n \"headers\": {\n \"enim3\": {\n \"description\": \"Any type\"\n }\n }\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-7312c8ca-441b-435c-aaaf-5ac92a7d84ad" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-84d4e5a9-9e64-48dc-b567-d9a87f49ee96" } ], "id": "17878534-3363-470e-995a-4695e796072a", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-17878534-3363-470e-995a-4695e796072a" }, { "name": "async-passthrough", "item": [ { "name": "{async_passthrough_receipt_id}", "item": [ { "name": "Retrieve", "id": "eca39f63-9c64-456a-b9d7-a2155436a6c9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/async-passthrough/:async_passthrough_receipt_id", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "async-passthrough", ":async_passthrough_receipt_id" ], "variable": [ { "id": "10b9f89b-46a2-41d0-8f38-aab5cff8d422", "key": "async_passthrough_receipt_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves data from earlier async-passthrough POST request" }, "response": [ { "id": "a482bb04-95de-4f8f-a4b8-3ac6d5b49d9f", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/async-passthrough/:async_passthrough_receipt_id", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "async-passthrough", ":async_passthrough_receipt_id" ], "variable": [ { "key": "async_passthrough_receipt_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"method\": \"\",\n \"path\": \"\",\n \"status\": \"\",\n \"response\": {\n \"description\": \"Any type\"\n },\n \"response_headers\": {\n \"laboris9dd\": {\n \"description\": \"Any type\"\n }\n },\n \"response_type\": \"BASE64_GZIP\",\n \"headers\": {\n \"enim3\": {\n \"description\": \"Any type\"\n }\n }\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-a482bb04-95de-4f8f-a4b8-3ac6d5b49d9f" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-eca39f63-9c64-456a-b9d7-a2155436a6c9" } ], "id": "1c9fed6c-dbe5-4b8d-901c-b2ce2aab1e17", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-1c9fed6c-dbe5-4b8d-901c-b2ce2aab1e17" }, { "name": "Create", "id": "dd6ab2ca-92ba-4ca4-bb1c-21466f7f786c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"HEAD\",\n \"path\": \"\",\n \"base_url_override\": \"\",\n \"data\": \"\",\n \"multipart_form_data\": [\n {\n \"name\": \"\",\n \"data\": \"\",\n \"encoding\": \"GZIP_BASE64\",\n \"file_name\": \"\",\n \"content_type\": \"\"\n },\n {\n \"name\": \"\",\n \"data\": \"\",\n \"encoding\": \"GZIP_BASE64\",\n \"file_name\": \"\",\n \"content_type\": \"\"\n }\n ],\n \"headers\": {\n \"reprehenderit_50c\": {\n \"description\": \"Any type\"\n },\n \"sunt6\": {\n \"description\": \"Any type\"\n }\n },\n \"request_format\": \"JSON\",\n \"normalize_response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/async-passthrough", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "async-passthrough" ] }, "description": "Asynchronously pull data from an endpoint not currently supported by Merge." }, "response": [ { "id": "17088274-2a0f-4f27-8d86-304725acc50c", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "(Required) Token identifying the end user.", "key": "X-Account-Token", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"method\": \"HEAD\",\n \"path\": \"\",\n \"base_url_override\": \"\",\n \"data\": \"\",\n \"multipart_form_data\": [\n {\n \"name\": \"\",\n \"data\": \"\",\n \"encoding\": \"GZIP_BASE64\",\n \"file_name\": \"\",\n \"content_type\": \"\"\n },\n {\n \"name\": \"\",\n \"data\": \"\",\n \"encoding\": \"GZIP_BASE64\",\n \"file_name\": \"\",\n \"content_type\": \"\"\n }\n ],\n \"headers\": {\n \"reprehenderit_50c\": {\n \"description\": \"Any type\"\n },\n \"sunt6\": {\n \"description\": \"Any type\"\n }\n },\n \"request_format\": \"JSON\",\n \"normalize_response\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/async-passthrough", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "async-passthrough" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"async_passthrough_receipt_id\": \"\"\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-17088274-2a0f-4f27-8d86-304725acc50c" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-dd6ab2ca-92ba-4ca4-bb1c-21466f7f786c" } ], "id": "6fbb4f5c-9102-4b3d-9eb6-8a61d2f5675e", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-6fbb4f5c-9102-4b3d-9eb6-8a61d2f5675e" }, { "name": "generate-key", "item": [ { "name": "Create", "id": "050aaf24-8408-483b-b76d-f8728f1d7296", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/generate-key", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "generate-key" ] }, "description": "Create a remote key." }, "response": [ { "id": "8723ec1e-62e6-45bb-9dd6-8bdfe8c8687c", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/generate-key", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "generate-key" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"key\": \"\"\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-8723ec1e-62e6-45bb-9dd6-8bdfe8c8687c" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-050aaf24-8408-483b-b76d-f8728f1d7296" } ], "id": "b87e27d6-c314-4a60-92ef-56ab7f509429", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-b87e27d6-c314-4a60-92ef-56ab7f509429" }, { "name": "regenerate-key", "item": [ { "name": "Create", "id": "3d09c19f-b3f1-4039-a89f-28149ba7d619", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/regenerate-key", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "regenerate-key" ] }, "description": "Exchange remote keys." }, "response": [ { "id": "c68d5a18-c729-4c6e-a15e-37e536cd0195", "name": "response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/knowledgebase/v1/regenerate-key", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "regenerate-key" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"name\": \"\",\n \"key\": \"\"\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-c68d5a18-c729-4c6e-a15e-37e536cd0195" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-3d09c19f-b3f1-4039-a89f-28149ba7d619" } ], "id": "f86c6a0e-84f5-4169-bdc9-dbc97d54a090", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-f86c6a0e-84f5-4169-bdc9-dbc97d54a090" }, { "name": "audit-trail", "item": [ { "name": "List", "id": "d95f3bd4-6884-4066-86c7-88908e058f9c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/audit-trail?cursor=&end_date=&event_type=&page_size=&start_date=&user_email=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "audit-trail" ], "query": [ { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "If included, will only include audit trail events that occurred before this time", "key": "end_date", "value": "" }, { "description": "If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`", "key": "event_type", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "If included, will only include audit trail events that occurred after this time", "key": "start_date", "value": "" }, { "description": "If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.", "key": "user_email", "value": "" } ] }, "description": "Gets a list of audit trail events." }, "response": [ { "id": "b550dc98-bde0-4812-bc17-fdfe95921402", "name": "response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/knowledgebase/v1/audit-trail?cursor=&end_date=&event_type=&page_size=&start_date=&user_email=", "host": [ "{{baseUrl}}" ], "path": [ "knowledgebase", "v1", "audit-trail" ], "query": [ { "description": "The pagination cursor value.", "key": "cursor", "value": "" }, { "description": "If included, will only include audit trail events that occurred before this time", "key": "end_date", "value": "" }, { "description": "If included, will only include events with the given event type. Possible values include: `CREATED_REMOTE_PRODUCTION_API_KEY`, `DELETED_REMOTE_PRODUCTION_API_KEY`, `CREATED_TEST_API_KEY`, `DELETED_TEST_API_KEY`, `REGENERATED_PRODUCTION_API_KEY`, `REGENERATED_WEBHOOK_SIGNATURE`, `INVITED_USER`, `TWO_FACTOR_AUTH_ENABLED`, `TWO_FACTOR_AUTH_DISABLED`, `DELETED_LINKED_ACCOUNT`, `DELETED_ALL_COMMON_MODELS_FOR_LINKED_ACCOUNT`, `CREATED_DESTINATION`, `DELETED_DESTINATION`, `CHANGED_DESTINATION`, `CHANGED_SCOPES`, `CHANGED_PERSONAL_INFORMATION`, `CHANGED_ORGANIZATION_SETTINGS`, `ENABLED_INTEGRATION`, `DISABLED_INTEGRATION`, `ENABLED_CATEGORY`, `DISABLED_CATEGORY`, `CHANGED_PASSWORD`, `RESET_PASSWORD`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `ENABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_ORGANIZATION`, `DISABLED_REDACT_UNMAPPED_DATA_FOR_LINKED_ACCOUNT`, `CREATED_INTEGRATION_WIDE_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_FIELD_MAPPING`, `CHANGED_INTEGRATION_WIDE_FIELD_MAPPING`, `CHANGED_LINKED_ACCOUNT_FIELD_MAPPING`, `DELETED_INTEGRATION_WIDE_FIELD_MAPPING`, `DELETED_LINKED_ACCOUNT_FIELD_MAPPING`, `CREATED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `CHANGED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE`, `FORCED_LINKED_ACCOUNT_RESYNC`, `MUTED_ISSUE`, `GENERATED_MAGIC_LINK`, `ENABLED_MERGE_WEBHOOK`, `DISABLED_MERGE_WEBHOOK`, `MERGE_WEBHOOK_TARGET_CHANGED`, `END_USER_CREDENTIALS_ACCESSED`", "key": "event_type", "value": "" }, { "description": "Number of results to return per page. The maximum limit is 100.", "key": "page_size", "value": "" }, { "description": "If included, will only include audit trail events that occurred after this time", "key": "start_date", "value": "" }, { "description": "If provided, this will return events associated with the specified user email. Please note that the email address reflects the user's email at the time of the event, and may not be their current email.", "key": "user_email", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"next\": \"\",\n \"previous\": \"\",\n \"results\": [\n {\n \"role\": \"MEMBER\",\n \"ip_address\": \"\",\n \"event_type\": \"DELETED_LINKED_ACCOUNT_COMMON_MODEL_OVERRIDE\",\n \"event_description\": \"\",\n \"id\": \"\",\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"created_at\": \"\"\n },\n {\n \"role\": \"ADMIN\",\n \"ip_address\": \"\",\n \"event_type\": \"CHANGED_PASSWORD\",\n \"event_description\": \"\",\n \"id\": \"\",\n \"user_name\": \"\",\n \"user_email\": \"\",\n \"created_at\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-b550dc98-bde0-4812-bc17-fdfe95921402" } ], "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-d95f3bd4-6884-4066-86c7-88908e058f9c" } ], "id": "4a039543-7647-499a-9bc7-eb84de474191", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-4a039543-7647-499a-9bc7-eb84de474191" } ], "id": "79941e6f-3e89-4076-bb73-337954809373", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-79941e6f-3e89-4076-bb73-337954809373" } ], "id": "7602fedc-63e6-4e38-831e-d94efe11a907", "createdAt": "2026-06-05T15:11:21.000Z", "updatedAt": "2026-06-05T15:11:21.000Z", "uid": "35240-7602fedc-63e6-4e38-831e-d94efe11a907" } ], "variable": [ { "key": "baseUrl", "value": "https://api.merge.dev/api" } ] }