# Help Center # Help Centers ## List help centers **get** `/v2/help_center/help_centers` Returns all help centers configured in your Featurebase organization. Currently, Featurebase only supports one help center per organization, but we plan on supporting multiple help centers in the future. ### Query Parameters - `limit` - Number of items to return (1-100, default 10) - `cursor` - Cursor for pagination ### Response Format Returns a list object with: - `object` - Always "list" - `data` - Array of help center objects - `nextCursor` - Cursor for next page (null if no more results) ### Help Center Object Each help center includes: - `id` - Unique identifier - `displayName` - Help center display name - `title` - Help center title - `description` - Help center description - `isPublic` - Whether the help center is publicly accessible - `defaultLocale` - Default locale for content - `availableLocales` - Array of available locales - `navItems` - Navigation items configuration - `urls` - URL configuration (subpath, custom domain) - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Query Parameters - `cursor: optional string` An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page. - `limit: optional number` A limit on the number of objects to be returned, between 1 and 100. ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `data: array of HelpCenter` Array of help centers - `id: string` Help center unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `defaultLocale: "bn" or "bs" or "pt-BR" or 39 more` Default locale for the help center - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `isPublic: boolean` Whether the help center is public - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "help_center"` Object type identifier - `"help_center"` - `organization: string` Organization ID - `updatedAt: string` ISO 8601 timestamp when last updated - `description: optional string` Help center description - `displayName: optional string` Help center display name - `externalLinksOpenInNewTab: optional boolean` Whether external links in articles open in a new tab - `hideAuthorInfo: optional boolean` Whether to hide author info on articles - `hideDateInfo: optional boolean` Whether to hide date info on articles - `internalLinksOpenInNewTab: optional boolean` Whether internal links in articles open in a new tab - `navItems: optional array of HelpCenterNavItem` Navigation items - `title: string` Navigation item title - `type: "link" or "button"` Navigation item type - `"link"` - `"button"` - `url: string` Navigation item URL - `icon: optional string` Navigation item icon - `searchPlaceholder: optional string` Search input placeholder - `title: optional string` Help center title - `translations: optional object { id, bg, bn, 39 more }` Translations for different locales - `id: optional HelpCenterTranslation` - `description: optional string` Description for this locale - `displayName: optional string` Display name for this locale - `navItems: optional array of HelpCenterNavItem` Navigation items for this locale - `title: string` Navigation item title - `type: "link" or "button"` Navigation item type - `url: string` Navigation item URL - `icon: optional string` Navigation item icon - `searchPlaceholder: optional string` Search placeholder for this locale - `title: optional string` Title for this locale - `bg: optional HelpCenterTranslation` - `bn: optional HelpCenterTranslation` - `bs: optional HelpCenterTranslation` - `ca: optional HelpCenterTranslation` - `cs: optional HelpCenterTranslation` - `da: optional HelpCenterTranslation` - `de: optional HelpCenterTranslation` - `el: optional HelpCenterTranslation` - `en: optional HelpCenterTranslation` - `es: optional HelpCenterTranslation` - `et: optional HelpCenterTranslation` - `fi: optional HelpCenterTranslation` - `fr: optional HelpCenterTranslation` - `hi: optional HelpCenterTranslation` - `hr: optional HelpCenterTranslation` - `hu: optional HelpCenterTranslation` - `it: optional HelpCenterTranslation` - `ja: optional HelpCenterTranslation` - `ko: optional HelpCenterTranslation` - `lt: optional HelpCenterTranslation` - `lv: optional HelpCenterTranslation` - `mn: optional HelpCenterTranslation` - `ms: optional HelpCenterTranslation` - `nb: optional HelpCenterTranslation` - `nl: optional HelpCenterTranslation` - `pl: optional HelpCenterTranslation` - `pt: optional HelpCenterTranslation` - `"pt-BR": optional HelpCenterTranslation` - `ro: optional HelpCenterTranslation` - `ru: optional HelpCenterTranslation` - `sk: optional HelpCenterTranslation` - `sl: optional HelpCenterTranslation` - `sr: optional HelpCenterTranslation` - `sv: optional HelpCenterTranslation` - `sw: optional HelpCenterTranslation` - `th: optional HelpCenterTranslation` - `tr: optional HelpCenterTranslation` - `uk: optional HelpCenterTranslation` - `vi: optional HelpCenterTranslation` - `"zh-CN": optional HelpCenterTranslation` - `"zh-TW": optional HelpCenterTranslation` - `urls: optional object { externalDomain, featurebaseSubpath }` URLs configuration - `externalDomain: optional string` External custom domain - `featurebaseSubpath: optional string` Featurebase subpath - `nextCursor: string` Cursor for fetching the next page (cursor-based pagination) - `object: "list"` Object type identifier - `"list"` ### Example ```http curl https://do.featurebase.app/v2/help_center/help_centers \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "data": [ { "id": "2tgy0ig982j54qfl", "availableLocales": [ "en" ], "createdAt": "2024-06-26T13:27:21.920Z", "defaultLocale": "en", "isPublic": true, "locale": "en", "object": "help_center", "organization": "6595518396205e06b897ad65", "updatedAt": "2024-06-26T13:52:19.415Z", "description": "", "displayName": "Your Help Center", "externalLinksOpenInNewTab": true, "hideAuthorInfo": false, "hideDateInfo": false, "internalLinksOpenInNewTab": false, "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search for help...", "title": "Help Center", "translations": { "id": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "bg": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "bn": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "bs": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ca": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "cs": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "da": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "de": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "el": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "en": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "es": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "et": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "fi": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "fr": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "hi": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "hr": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "hu": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "it": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ja": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ko": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "lt": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "lv": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "mn": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ms": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "nb": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "nl": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "pl": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "pt": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "pt-BR": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ro": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ru": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "sk": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "sl": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "sr": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "sv": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "sw": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "th": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "tr": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "uk": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "vi": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "zh-CN": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "zh-TW": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" } }, "urls": { "externalDomain": "help.example.com", "featurebaseSubpath": "/help" } } ], "nextCursor": null, "object": "list" } ``` ## Get a help center by ID **get** `/v2/help_center/help_centers/{id}` Retrieves a single help center by its unique identifier. Returns the help center object if found in your organization. ### Response Returns a help center object with: - `id` - Unique identifier - `displayName` - Help center display name - `title` - Help center title - `description` - Help center description - `searchPlaceholder` - Search input placeholder text - `isPublic` - Whether the help center is publicly accessible - `defaultLocale` - Default locale for content - `locale` - Current locale - `availableLocales` - Array of available locales - `navItems` - Navigation items configuration - `urls` - URL configuration (subpath, custom domain) - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Errors - `404` - Help center not found in your organization ### Path Parameters - `id: string` Help center unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `HelpCenter object { id, availableLocales, createdAt, 17 more }` - `id: string` Help center unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `defaultLocale: "bn" or "bs" or "pt-BR" or 39 more` Default locale for the help center - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `isPublic: boolean` Whether the help center is public - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "help_center"` Object type identifier - `"help_center"` - `organization: string` Organization ID - `updatedAt: string` ISO 8601 timestamp when last updated - `description: optional string` Help center description - `displayName: optional string` Help center display name - `externalLinksOpenInNewTab: optional boolean` Whether external links in articles open in a new tab - `hideAuthorInfo: optional boolean` Whether to hide author info on articles - `hideDateInfo: optional boolean` Whether to hide date info on articles - `internalLinksOpenInNewTab: optional boolean` Whether internal links in articles open in a new tab - `navItems: optional array of HelpCenterNavItem` Navigation items - `title: string` Navigation item title - `type: "link" or "button"` Navigation item type - `"link"` - `"button"` - `url: string` Navigation item URL - `icon: optional string` Navigation item icon - `searchPlaceholder: optional string` Search input placeholder - `title: optional string` Help center title - `translations: optional object { id, bg, bn, 39 more }` Translations for different locales - `id: optional HelpCenterTranslation` - `description: optional string` Description for this locale - `displayName: optional string` Display name for this locale - `navItems: optional array of HelpCenterNavItem` Navigation items for this locale - `title: string` Navigation item title - `type: "link" or "button"` Navigation item type - `url: string` Navigation item URL - `icon: optional string` Navigation item icon - `searchPlaceholder: optional string` Search placeholder for this locale - `title: optional string` Title for this locale - `bg: optional HelpCenterTranslation` - `bn: optional HelpCenterTranslation` - `bs: optional HelpCenterTranslation` - `ca: optional HelpCenterTranslation` - `cs: optional HelpCenterTranslation` - `da: optional HelpCenterTranslation` - `de: optional HelpCenterTranslation` - `el: optional HelpCenterTranslation` - `en: optional HelpCenterTranslation` - `es: optional HelpCenterTranslation` - `et: optional HelpCenterTranslation` - `fi: optional HelpCenterTranslation` - `fr: optional HelpCenterTranslation` - `hi: optional HelpCenterTranslation` - `hr: optional HelpCenterTranslation` - `hu: optional HelpCenterTranslation` - `it: optional HelpCenterTranslation` - `ja: optional HelpCenterTranslation` - `ko: optional HelpCenterTranslation` - `lt: optional HelpCenterTranslation` - `lv: optional HelpCenterTranslation` - `mn: optional HelpCenterTranslation` - `ms: optional HelpCenterTranslation` - `nb: optional HelpCenterTranslation` - `nl: optional HelpCenterTranslation` - `pl: optional HelpCenterTranslation` - `pt: optional HelpCenterTranslation` - `"pt-BR": optional HelpCenterTranslation` - `ro: optional HelpCenterTranslation` - `ru: optional HelpCenterTranslation` - `sk: optional HelpCenterTranslation` - `sl: optional HelpCenterTranslation` - `sr: optional HelpCenterTranslation` - `sv: optional HelpCenterTranslation` - `sw: optional HelpCenterTranslation` - `th: optional HelpCenterTranslation` - `tr: optional HelpCenterTranslation` - `uk: optional HelpCenterTranslation` - `vi: optional HelpCenterTranslation` - `"zh-CN": optional HelpCenterTranslation` - `"zh-TW": optional HelpCenterTranslation` - `urls: optional object { externalDomain, featurebaseSubpath }` URLs configuration - `externalDomain: optional string` External custom domain - `featurebaseSubpath: optional string` Featurebase subpath ### Example ```http curl https://do.featurebase.app/v2/help_center/help_centers/$ID \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "id": "2tgy0ig982j54qfl", "availableLocales": [ "en" ], "createdAt": "2024-06-26T13:27:21.920Z", "defaultLocale": "en", "isPublic": true, "locale": "en", "object": "help_center", "organization": "6595518396205e06b897ad65", "updatedAt": "2024-06-26T13:52:19.415Z", "description": "", "displayName": "Your Help Center", "externalLinksOpenInNewTab": true, "hideAuthorInfo": false, "hideDateInfo": false, "internalLinksOpenInNewTab": false, "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search for help...", "title": "Help Center", "translations": { "id": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "bg": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "bn": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "bs": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ca": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "cs": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "da": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "de": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "el": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "en": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "es": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "et": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "fi": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "fr": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "hi": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "hr": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "hu": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "it": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ja": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ko": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "lt": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "lv": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "mn": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ms": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "nb": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "nl": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "pl": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "pt": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "pt-BR": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ro": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "ru": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "sk": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "sl": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "sr": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "sv": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "sw": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "th": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "tr": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "uk": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "vi": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "zh-CN": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" }, "zh-TW": { "description": "Find answers to common questions", "displayName": "My English Help Center", "navItems": [ { "title": "Developer Docs", "type": "link", "url": "https://developers.featurebase.app/install", "icon": null } ], "searchPlaceholder": "Search articles...", "title": "Help Center" } }, "urls": { "externalDomain": "help.example.com", "featurebaseSubpath": "/help" } } ``` ## Domain Types ### Help Center - `HelpCenter object { id, availableLocales, createdAt, 17 more }` - `id: string` Help center unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `defaultLocale: "bn" or "bs" or "pt-BR" or 39 more` Default locale for the help center - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `isPublic: boolean` Whether the help center is public - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "help_center"` Object type identifier - `"help_center"` - `organization: string` Organization ID - `updatedAt: string` ISO 8601 timestamp when last updated - `description: optional string` Help center description - `displayName: optional string` Help center display name - `externalLinksOpenInNewTab: optional boolean` Whether external links in articles open in a new tab - `hideAuthorInfo: optional boolean` Whether to hide author info on articles - `hideDateInfo: optional boolean` Whether to hide date info on articles - `internalLinksOpenInNewTab: optional boolean` Whether internal links in articles open in a new tab - `navItems: optional array of HelpCenterNavItem` Navigation items - `title: string` Navigation item title - `type: "link" or "button"` Navigation item type - `"link"` - `"button"` - `url: string` Navigation item URL - `icon: optional string` Navigation item icon - `searchPlaceholder: optional string` Search input placeholder - `title: optional string` Help center title - `translations: optional object { id, bg, bn, 39 more }` Translations for different locales - `id: optional HelpCenterTranslation` - `description: optional string` Description for this locale - `displayName: optional string` Display name for this locale - `navItems: optional array of HelpCenterNavItem` Navigation items for this locale - `title: string` Navigation item title - `type: "link" or "button"` Navigation item type - `url: string` Navigation item URL - `icon: optional string` Navigation item icon - `searchPlaceholder: optional string` Search placeholder for this locale - `title: optional string` Title for this locale - `bg: optional HelpCenterTranslation` - `bn: optional HelpCenterTranslation` - `bs: optional HelpCenterTranslation` - `ca: optional HelpCenterTranslation` - `cs: optional HelpCenterTranslation` - `da: optional HelpCenterTranslation` - `de: optional HelpCenterTranslation` - `el: optional HelpCenterTranslation` - `en: optional HelpCenterTranslation` - `es: optional HelpCenterTranslation` - `et: optional HelpCenterTranslation` - `fi: optional HelpCenterTranslation` - `fr: optional HelpCenterTranslation` - `hi: optional HelpCenterTranslation` - `hr: optional HelpCenterTranslation` - `hu: optional HelpCenterTranslation` - `it: optional HelpCenterTranslation` - `ja: optional HelpCenterTranslation` - `ko: optional HelpCenterTranslation` - `lt: optional HelpCenterTranslation` - `lv: optional HelpCenterTranslation` - `mn: optional HelpCenterTranslation` - `ms: optional HelpCenterTranslation` - `nb: optional HelpCenterTranslation` - `nl: optional HelpCenterTranslation` - `pl: optional HelpCenterTranslation` - `pt: optional HelpCenterTranslation` - `"pt-BR": optional HelpCenterTranslation` - `ro: optional HelpCenterTranslation` - `ru: optional HelpCenterTranslation` - `sk: optional HelpCenterTranslation` - `sl: optional HelpCenterTranslation` - `sr: optional HelpCenterTranslation` - `sv: optional HelpCenterTranslation` - `sw: optional HelpCenterTranslation` - `th: optional HelpCenterTranslation` - `tr: optional HelpCenterTranslation` - `uk: optional HelpCenterTranslation` - `vi: optional HelpCenterTranslation` - `"zh-CN": optional HelpCenterTranslation` - `"zh-TW": optional HelpCenterTranslation` - `urls: optional object { externalDomain, featurebaseSubpath }` URLs configuration - `externalDomain: optional string` External custom domain - `featurebaseSubpath: optional string` Featurebase subpath ### Help Center Nav Item - `HelpCenterNavItem object { title, type, url, icon }` - `title: string` Navigation item title - `type: "link" or "button"` Navigation item type - `"link"` - `"button"` - `url: string` Navigation item URL - `icon: optional string` Navigation item icon ### Help Center Translation - `HelpCenterTranslation object { description, displayName, navItems, 2 more }` - `description: optional string` Description for this locale - `displayName: optional string` Display name for this locale - `navItems: optional array of HelpCenterNavItem` Navigation items for this locale - `title: string` Navigation item title - `type: "link" or "button"` Navigation item type - `"link"` - `"button"` - `url: string` Navigation item URL - `icon: optional string` Navigation item icon - `searchPlaceholder: optional string` Search placeholder for this locale - `title: optional string` Title for this locale # Collections ## List collections **get** `/v2/help_center/collections` Returns a paginated list of collections within your organization's help center. Collections are used to organize articles into logical groups. ### Query Parameters - `limit` - Number of items to return (1-100, default 10) - `cursor` - Cursor for pagination ### Response Format Returns a list object with: - `object` - Always "list" - `data` - Array of collection objects - `nextCursor` - Cursor for next page (null if no more results) ### Collection Object Each collection includes: - `id` - Unique identifier - `name` - Collection name - `description` - Collection description - `slug` - URL slug - `icon` - Collection icon (emoji or custom) - `parentId` - Parent collection ID (null for root collections) - `helpCenterId` - ID of the help center this collection belongs to - `organization` - Organization ID - `defaultLocale` - Default locale for content - `locale` - Current locale - `availableLocales` - Array of available locales - `featurebaseUrl` - Featurebase URL for the collection - `externalUrl` - External URL if custom domain is configured - `articleCount` - Number of articles in this collection - `authorCount` - Number of authors who contributed - `order` - Display order - `translations` - Translations for different locales - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Query Parameters - `cursor: optional string` An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page. - `helpCenterId: optional string` Filter collections by help center ID. If omitted, returns collections across all help centers. - `limit: optional number` A limit on the number of objects to be returned, between 1 and 100. ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `data: array of Collection` Array of collections - `id: string` Collection unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `helpCenterId: string` Help center ID - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "collection"` Object type identifier - `"collection"` - `organization: string` Organization ID - `parentId: string` Parent collection ID - `updatedAt: string` ISO 8601 timestamp when last updated - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `collapseSidebar: optional boolean` Whether to collapse sidebar - `defaultLocale: optional "bn" or "bs" or "pt-BR" or 39 more` Default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `icon: optional object { type, value }` Collection icon - `type: string` Icon type - `value: string` Icon value - `name: optional string` Collection name - `order: optional number` Display order - `path: optional string` Collection path - `slug: optional string` URL slug - `translations: optional object { id, bg, bn, 39 more }` Translations by locale code - `id: optional CollectionTranslation` - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `authors: optional array of object { authorId, avatarUrl, name }` List of authors - `authorId: optional string` Author ID - `avatarUrl: optional string` Author avatar URL - `name: optional string` Author name - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `name: optional string` Collection name - `slug: optional string` URL slug - `bg: optional CollectionTranslation` - `bn: optional CollectionTranslation` - `bs: optional CollectionTranslation` - `ca: optional CollectionTranslation` - `cs: optional CollectionTranslation` - `da: optional CollectionTranslation` - `de: optional CollectionTranslation` - `el: optional CollectionTranslation` - `en: optional CollectionTranslation` - `es: optional CollectionTranslation` - `et: optional CollectionTranslation` - `fi: optional CollectionTranslation` - `fr: optional CollectionTranslation` - `hi: optional CollectionTranslation` - `hr: optional CollectionTranslation` - `hu: optional CollectionTranslation` - `it: optional CollectionTranslation` - `ja: optional CollectionTranslation` - `ko: optional CollectionTranslation` - `lt: optional CollectionTranslation` - `lv: optional CollectionTranslation` - `mn: optional CollectionTranslation` - `ms: optional CollectionTranslation` - `nb: optional CollectionTranslation` - `nl: optional CollectionTranslation` - `pl: optional CollectionTranslation` - `pt: optional CollectionTranslation` - `"pt-BR": optional CollectionTranslation` - `ro: optional CollectionTranslation` - `ru: optional CollectionTranslation` - `sk: optional CollectionTranslation` - `sl: optional CollectionTranslation` - `sr: optional CollectionTranslation` - `sv: optional CollectionTranslation` - `sw: optional CollectionTranslation` - `th: optional CollectionTranslation` - `tr: optional CollectionTranslation` - `uk: optional CollectionTranslation` - `vi: optional CollectionTranslation` - `"zh-CN": optional CollectionTranslation` - `"zh-TW": optional CollectionTranslation` - `nextCursor: string` Cursor for fetching the next page (cursor-based pagination) - `object: "list"` Object type identifier - `"list"` ### Example ```http curl https://do.featurebase.app/v2/help_center/collections \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "data": [ { "id": "6474684", "availableLocales": [ "en", "de" ], "createdAt": "2024-10-18T12:33:09.099Z", "helpCenterId": "j7c5g8ah3ewxp4lo", "locale": "en", "object": "collection", "organization": "6595518396205e06b897ad65", "parentId": null, "updatedAt": "2024-10-18T13:03:25.921Z", "articleCount": 15, "authorCount": 3, "collapseSidebar": false, "defaultLocale": "en", "description": "A description in English", "externalUrl": "https://help.yourdomain.com/en/collections/6474684-english-version", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/6474684-english-version", "icon": { "type": "emoji", "value": "🥾" }, "name": "English Collection Name", "order": 1, "path": "ox6qrqprmsuqaunj/3876752/3513543", "slug": "6474684-english-version", "translations": { "id": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bg": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bn": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bs": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ca": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "cs": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "da": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "de": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "el": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "en": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "es": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "et": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "fi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "fr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hu": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "it": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ja": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ko": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "lt": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "lv": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "mn": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ms": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "nb": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "nl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pt": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pt-BR": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ro": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ru": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sk": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sv": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sw": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "th": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "tr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "uk": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "vi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "zh-CN": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "zh-TW": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" } } } ], "nextCursor": null, "object": "list" } ``` ## Create a collection **post** `/v2/help_center/collections` Creates a new collection in your organization's help center. ### Request Body Required attributes: - `name` - The name of the collection Optional attributes: - `description` - A description of the collection - `icon` - An icon object representing the collection icon (with type and value) - `parentId` - The ID of the parent collection, if any - `translations` - A dictionary of translations keyed by locale ### Response Returns the created collection object with: - `id` - Unique identifier - `name` - Collection name - `description` - Collection description - `slug` - URL slug - `icon` - Collection icon (emoji or custom) - `parentId` - Parent collection ID (null for root collections) - `helpCenterId` - ID of the help center this collection belongs to - `organization` - Organization ID - `defaultLocale` - Default locale for content - `locale` - Current locale - `availableLocales` - Array of available locales - `featurebaseUrl` - Featurebase URL for the collection - `externalUrl` - External URL if custom domain is configured - `articleCount` - Number of articles in this collection - `authorCount` - Number of authors who contributed - `order` - Display order - `translations` - Translations for different locales - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `name: string` The name of the collection - `description: optional string` A description of the collection - `icon: optional CollectionIconNova` An updated icon object for the collection - `type: "emoji" or "predefined"` Icon type (e.g., "emoji") - `"emoji"` - `"predefined"` - `value: string` Icon value - `parentId: optional string` The ID of the parent collection, if any - `translations: optional object { id, bg, bn, 39 more }` A dictionary of translations keyed by locale - `id: optional CollectionTranslationInputNova` - `description: optional string` Collection description in this locale - `name: optional string` Collection name in this locale - `bg: optional CollectionTranslationInputNova` - `bn: optional CollectionTranslationInputNova` - `bs: optional CollectionTranslationInputNova` - `ca: optional CollectionTranslationInputNova` - `cs: optional CollectionTranslationInputNova` - `da: optional CollectionTranslationInputNova` - `de: optional CollectionTranslationInputNova` - `el: optional CollectionTranslationInputNova` - `en: optional CollectionTranslationInputNova` - `es: optional CollectionTranslationInputNova` - `et: optional CollectionTranslationInputNova` - `fi: optional CollectionTranslationInputNova` - `fr: optional CollectionTranslationInputNova` - `hi: optional CollectionTranslationInputNova` - `hr: optional CollectionTranslationInputNova` - `hu: optional CollectionTranslationInputNova` - `it: optional CollectionTranslationInputNova` - `ja: optional CollectionTranslationInputNova` - `ko: optional CollectionTranslationInputNova` - `lt: optional CollectionTranslationInputNova` - `lv: optional CollectionTranslationInputNova` - `mn: optional CollectionTranslationInputNova` - `ms: optional CollectionTranslationInputNova` - `nb: optional CollectionTranslationInputNova` - `nl: optional CollectionTranslationInputNova` - `pl: optional CollectionTranslationInputNova` - `pt: optional CollectionTranslationInputNova` - `"pt-BR": optional CollectionTranslationInputNova` - `ro: optional CollectionTranslationInputNova` - `ru: optional CollectionTranslationInputNova` - `sk: optional CollectionTranslationInputNova` - `sl: optional CollectionTranslationInputNova` - `sr: optional CollectionTranslationInputNova` - `sv: optional CollectionTranslationInputNova` - `sw: optional CollectionTranslationInputNova` - `th: optional CollectionTranslationInputNova` - `tr: optional CollectionTranslationInputNova` - `uk: optional CollectionTranslationInputNova` - `vi: optional CollectionTranslationInputNova` - `"zh-CN": optional CollectionTranslationInputNova` - `"zh-TW": optional CollectionTranslationInputNova` ### Returns - `Collection object { id, availableLocales, createdAt, 19 more }` - `id: string` Collection unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `helpCenterId: string` Help center ID - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "collection"` Object type identifier - `"collection"` - `organization: string` Organization ID - `parentId: string` Parent collection ID - `updatedAt: string` ISO 8601 timestamp when last updated - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `collapseSidebar: optional boolean` Whether to collapse sidebar - `defaultLocale: optional "bn" or "bs" or "pt-BR" or 39 more` Default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `icon: optional object { type, value }` Collection icon - `type: string` Icon type - `value: string` Icon value - `name: optional string` Collection name - `order: optional number` Display order - `path: optional string` Collection path - `slug: optional string` URL slug - `translations: optional object { id, bg, bn, 39 more }` Translations by locale code - `id: optional CollectionTranslation` - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `authors: optional array of object { authorId, avatarUrl, name }` List of authors - `authorId: optional string` Author ID - `avatarUrl: optional string` Author avatar URL - `name: optional string` Author name - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `name: optional string` Collection name - `slug: optional string` URL slug - `bg: optional CollectionTranslation` - `bn: optional CollectionTranslation` - `bs: optional CollectionTranslation` - `ca: optional CollectionTranslation` - `cs: optional CollectionTranslation` - `da: optional CollectionTranslation` - `de: optional CollectionTranslation` - `el: optional CollectionTranslation` - `en: optional CollectionTranslation` - `es: optional CollectionTranslation` - `et: optional CollectionTranslation` - `fi: optional CollectionTranslation` - `fr: optional CollectionTranslation` - `hi: optional CollectionTranslation` - `hr: optional CollectionTranslation` - `hu: optional CollectionTranslation` - `it: optional CollectionTranslation` - `ja: optional CollectionTranslation` - `ko: optional CollectionTranslation` - `lt: optional CollectionTranslation` - `lv: optional CollectionTranslation` - `mn: optional CollectionTranslation` - `ms: optional CollectionTranslation` - `nb: optional CollectionTranslation` - `nl: optional CollectionTranslation` - `pl: optional CollectionTranslation` - `pt: optional CollectionTranslation` - `"pt-BR": optional CollectionTranslation` - `ro: optional CollectionTranslation` - `ru: optional CollectionTranslation` - `sk: optional CollectionTranslation` - `sl: optional CollectionTranslation` - `sr: optional CollectionTranslation` - `sv: optional CollectionTranslation` - `sw: optional CollectionTranslation` - `th: optional CollectionTranslation` - `tr: optional CollectionTranslation` - `uk: optional CollectionTranslation` - `vi: optional CollectionTranslation` - `"zh-CN": optional CollectionTranslation` - `"zh-TW": optional CollectionTranslation` ### Example ```http curl https://do.featurebase.app/v2/help_center/collections \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "name": "English Collection", "description": "This is a collection of articles in English." }' ``` #### Response ```json { "id": "6474684", "availableLocales": [ "en", "de" ], "createdAt": "2024-10-18T12:33:09.099Z", "helpCenterId": "j7c5g8ah3ewxp4lo", "locale": "en", "object": "collection", "organization": "6595518396205e06b897ad65", "parentId": null, "updatedAt": "2024-10-18T13:03:25.921Z", "articleCount": 15, "authorCount": 3, "collapseSidebar": false, "defaultLocale": "en", "description": "A description in English", "externalUrl": "https://help.yourdomain.com/en/collections/6474684-english-version", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/6474684-english-version", "icon": { "type": "emoji", "value": "🥾" }, "name": "English Collection Name", "order": 1, "path": "ox6qrqprmsuqaunj/3876752/3513543", "slug": "6474684-english-version", "translations": { "id": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bg": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bn": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bs": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ca": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "cs": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "da": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "de": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "el": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "en": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "es": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "et": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "fi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "fr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hu": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "it": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ja": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ko": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "lt": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "lv": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "mn": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ms": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "nb": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "nl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pt": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pt-BR": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ro": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ru": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sk": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sv": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sw": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "th": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "tr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "uk": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "vi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "zh-CN": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "zh-TW": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" } } } ``` ## Get a collection by ID **get** `/v2/help_center/collections/{id}` Retrieves a specific collection by its unique identifier. Returns the collection object if found in your organization's help center. ### Response Returns a collection object with: - `id` - Unique identifier - `name` - Collection name - `description` - Collection description - `slug` - URL slug - `icon` - Collection icon (emoji or custom) - `parentId` - Parent collection ID (null for root collections) - `helpCenterId` - ID of the help center this collection belongs to - `organization` - Organization ID - `defaultLocale` - Default locale for content - `locale` - Current locale - `availableLocales` - Array of available locales - `featurebaseUrl` - Featurebase URL for the collection - `externalUrl` - External URL if custom domain is configured - `articleCount` - Number of articles in this collection - `authorCount` - Number of authors who contributed - `order` - Display order - `translations` - Translations for different locales - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Errors - `404` - Collection not found in your organization's help center ### Path Parameters - `id: string` Collection unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `Collection object { id, availableLocales, createdAt, 19 more }` - `id: string` Collection unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `helpCenterId: string` Help center ID - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "collection"` Object type identifier - `"collection"` - `organization: string` Organization ID - `parentId: string` Parent collection ID - `updatedAt: string` ISO 8601 timestamp when last updated - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `collapseSidebar: optional boolean` Whether to collapse sidebar - `defaultLocale: optional "bn" or "bs" or "pt-BR" or 39 more` Default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `icon: optional object { type, value }` Collection icon - `type: string` Icon type - `value: string` Icon value - `name: optional string` Collection name - `order: optional number` Display order - `path: optional string` Collection path - `slug: optional string` URL slug - `translations: optional object { id, bg, bn, 39 more }` Translations by locale code - `id: optional CollectionTranslation` - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `authors: optional array of object { authorId, avatarUrl, name }` List of authors - `authorId: optional string` Author ID - `avatarUrl: optional string` Author avatar URL - `name: optional string` Author name - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `name: optional string` Collection name - `slug: optional string` URL slug - `bg: optional CollectionTranslation` - `bn: optional CollectionTranslation` - `bs: optional CollectionTranslation` - `ca: optional CollectionTranslation` - `cs: optional CollectionTranslation` - `da: optional CollectionTranslation` - `de: optional CollectionTranslation` - `el: optional CollectionTranslation` - `en: optional CollectionTranslation` - `es: optional CollectionTranslation` - `et: optional CollectionTranslation` - `fi: optional CollectionTranslation` - `fr: optional CollectionTranslation` - `hi: optional CollectionTranslation` - `hr: optional CollectionTranslation` - `hu: optional CollectionTranslation` - `it: optional CollectionTranslation` - `ja: optional CollectionTranslation` - `ko: optional CollectionTranslation` - `lt: optional CollectionTranslation` - `lv: optional CollectionTranslation` - `mn: optional CollectionTranslation` - `ms: optional CollectionTranslation` - `nb: optional CollectionTranslation` - `nl: optional CollectionTranslation` - `pl: optional CollectionTranslation` - `pt: optional CollectionTranslation` - `"pt-BR": optional CollectionTranslation` - `ro: optional CollectionTranslation` - `ru: optional CollectionTranslation` - `sk: optional CollectionTranslation` - `sl: optional CollectionTranslation` - `sr: optional CollectionTranslation` - `sv: optional CollectionTranslation` - `sw: optional CollectionTranslation` - `th: optional CollectionTranslation` - `tr: optional CollectionTranslation` - `uk: optional CollectionTranslation` - `vi: optional CollectionTranslation` - `"zh-CN": optional CollectionTranslation` - `"zh-TW": optional CollectionTranslation` ### Example ```http curl https://do.featurebase.app/v2/help_center/collections/$ID \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "id": "6474684", "availableLocales": [ "en", "de" ], "createdAt": "2024-10-18T12:33:09.099Z", "helpCenterId": "j7c5g8ah3ewxp4lo", "locale": "en", "object": "collection", "organization": "6595518396205e06b897ad65", "parentId": null, "updatedAt": "2024-10-18T13:03:25.921Z", "articleCount": 15, "authorCount": 3, "collapseSidebar": false, "defaultLocale": "en", "description": "A description in English", "externalUrl": "https://help.yourdomain.com/en/collections/6474684-english-version", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/6474684-english-version", "icon": { "type": "emoji", "value": "🥾" }, "name": "English Collection Name", "order": 1, "path": "ox6qrqprmsuqaunj/3876752/3513543", "slug": "6474684-english-version", "translations": { "id": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bg": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bn": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bs": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ca": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "cs": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "da": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "de": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "el": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "en": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "es": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "et": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "fi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "fr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hu": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "it": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ja": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ko": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "lt": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "lv": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "mn": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ms": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "nb": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "nl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pt": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pt-BR": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ro": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ru": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sk": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sv": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sw": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "th": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "tr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "uk": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "vi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "zh-CN": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "zh-TW": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" } } } ``` ## Update a collection **patch** `/v2/help_center/collections/{id}` Updates an existing collection. Only include the fields you wish to update. ### Path Parameters - `id` - The unique identifier of the collection to update ### Request Body All fields are optional. Only provided fields will be updated: - `name` - The new name of the collection - `description` - The new description of the collection - `icon` - An updated icon object for the collection (with type and value) - `parentId` - The new parent collection ID, if applicable (null for root level) - `translations` - A dictionary of updated translations keyed by locale code ### Response Returns the updated collection object with: - `id` - Unique identifier - `name` - Collection name - `description` - Collection description - `slug` - URL slug - `icon` - Collection icon (emoji or custom) - `parentId` - Parent collection ID (null for root collections) - `helpCenterId` - ID of the help center this collection belongs to - `organization` - Organization ID - `defaultLocale` - Default locale for content - `locale` - Current locale - `availableLocales` - Array of available locales - `featurebaseUrl` - Featurebase URL for the collection - `externalUrl` - External URL if custom domain is configured - `articleCount` - Number of articles in this collection - `authorCount` - Number of authors who contributed - `order` - Display order - `translations` - Translations for different locales - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Errors - `404` - Collection not found in your organization's help center ### Path Parameters - `id: string` The collection unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `description: optional string` The new description of the collection - `icon: optional CollectionIconNova` An updated icon object for the collection - `type: "emoji" or "predefined"` Icon type (e.g., "emoji") - `"emoji"` - `"predefined"` - `value: string` Icon value - `name: optional string` The new name of the collection - `parentId: optional string` The new parent collection ID, if applicable - `translations: optional object { id, bg, bn, 39 more }` A dictionary of updated translations keyed by locale - `id: optional CollectionTranslationInputNova` - `description: optional string` Collection description in this locale - `name: optional string` Collection name in this locale - `bg: optional CollectionTranslationInputNova` - `bn: optional CollectionTranslationInputNova` - `bs: optional CollectionTranslationInputNova` - `ca: optional CollectionTranslationInputNova` - `cs: optional CollectionTranslationInputNova` - `da: optional CollectionTranslationInputNova` - `de: optional CollectionTranslationInputNova` - `el: optional CollectionTranslationInputNova` - `en: optional CollectionTranslationInputNova` - `es: optional CollectionTranslationInputNova` - `et: optional CollectionTranslationInputNova` - `fi: optional CollectionTranslationInputNova` - `fr: optional CollectionTranslationInputNova` - `hi: optional CollectionTranslationInputNova` - `hr: optional CollectionTranslationInputNova` - `hu: optional CollectionTranslationInputNova` - `it: optional CollectionTranslationInputNova` - `ja: optional CollectionTranslationInputNova` - `ko: optional CollectionTranslationInputNova` - `lt: optional CollectionTranslationInputNova` - `lv: optional CollectionTranslationInputNova` - `mn: optional CollectionTranslationInputNova` - `ms: optional CollectionTranslationInputNova` - `nb: optional CollectionTranslationInputNova` - `nl: optional CollectionTranslationInputNova` - `pl: optional CollectionTranslationInputNova` - `pt: optional CollectionTranslationInputNova` - `"pt-BR": optional CollectionTranslationInputNova` - `ro: optional CollectionTranslationInputNova` - `ru: optional CollectionTranslationInputNova` - `sk: optional CollectionTranslationInputNova` - `sl: optional CollectionTranslationInputNova` - `sr: optional CollectionTranslationInputNova` - `sv: optional CollectionTranslationInputNova` - `sw: optional CollectionTranslationInputNova` - `th: optional CollectionTranslationInputNova` - `tr: optional CollectionTranslationInputNova` - `uk: optional CollectionTranslationInputNova` - `vi: optional CollectionTranslationInputNova` - `"zh-CN": optional CollectionTranslationInputNova` - `"zh-TW": optional CollectionTranslationInputNova` ### Returns - `Collection object { id, availableLocales, createdAt, 19 more }` - `id: string` Collection unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `helpCenterId: string` Help center ID - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "collection"` Object type identifier - `"collection"` - `organization: string` Organization ID - `parentId: string` Parent collection ID - `updatedAt: string` ISO 8601 timestamp when last updated - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `collapseSidebar: optional boolean` Whether to collapse sidebar - `defaultLocale: optional "bn" or "bs" or "pt-BR" or 39 more` Default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `icon: optional object { type, value }` Collection icon - `type: string` Icon type - `value: string` Icon value - `name: optional string` Collection name - `order: optional number` Display order - `path: optional string` Collection path - `slug: optional string` URL slug - `translations: optional object { id, bg, bn, 39 more }` Translations by locale code - `id: optional CollectionTranslation` - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `authors: optional array of object { authorId, avatarUrl, name }` List of authors - `authorId: optional string` Author ID - `avatarUrl: optional string` Author avatar URL - `name: optional string` Author name - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `name: optional string` Collection name - `slug: optional string` URL slug - `bg: optional CollectionTranslation` - `bn: optional CollectionTranslation` - `bs: optional CollectionTranslation` - `ca: optional CollectionTranslation` - `cs: optional CollectionTranslation` - `da: optional CollectionTranslation` - `de: optional CollectionTranslation` - `el: optional CollectionTranslation` - `en: optional CollectionTranslation` - `es: optional CollectionTranslation` - `et: optional CollectionTranslation` - `fi: optional CollectionTranslation` - `fr: optional CollectionTranslation` - `hi: optional CollectionTranslation` - `hr: optional CollectionTranslation` - `hu: optional CollectionTranslation` - `it: optional CollectionTranslation` - `ja: optional CollectionTranslation` - `ko: optional CollectionTranslation` - `lt: optional CollectionTranslation` - `lv: optional CollectionTranslation` - `mn: optional CollectionTranslation` - `ms: optional CollectionTranslation` - `nb: optional CollectionTranslation` - `nl: optional CollectionTranslation` - `pl: optional CollectionTranslation` - `pt: optional CollectionTranslation` - `"pt-BR": optional CollectionTranslation` - `ro: optional CollectionTranslation` - `ru: optional CollectionTranslation` - `sk: optional CollectionTranslation` - `sl: optional CollectionTranslation` - `sr: optional CollectionTranslation` - `sv: optional CollectionTranslation` - `sw: optional CollectionTranslation` - `th: optional CollectionTranslation` - `tr: optional CollectionTranslation` - `uk: optional CollectionTranslation` - `vi: optional CollectionTranslation` - `"zh-CN": optional CollectionTranslation` - `"zh-TW": optional CollectionTranslation` ### Example ```http curl https://do.featurebase.app/v2/help_center/collections/$ID \ -X PATCH \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "description": "Updated description in English.", "name": "Updated Collection" }' ``` #### Response ```json { "id": "6474684", "availableLocales": [ "en", "de" ], "createdAt": "2024-10-18T12:33:09.099Z", "helpCenterId": "j7c5g8ah3ewxp4lo", "locale": "en", "object": "collection", "organization": "6595518396205e06b897ad65", "parentId": null, "updatedAt": "2024-10-18T13:03:25.921Z", "articleCount": 15, "authorCount": 3, "collapseSidebar": false, "defaultLocale": "en", "description": "A description in English", "externalUrl": "https://help.yourdomain.com/en/collections/6474684-english-version", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/6474684-english-version", "icon": { "type": "emoji", "value": "🥾" }, "name": "English Collection Name", "order": 1, "path": "ox6qrqprmsuqaunj/3876752/3513543", "slug": "6474684-english-version", "translations": { "id": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bg": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bn": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "bs": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ca": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "cs": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "da": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "de": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "el": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "en": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "es": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "et": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "fi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "fr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "hu": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "it": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ja": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ko": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "lt": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "lv": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "mn": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ms": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "nb": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "nl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pt": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "pt-BR": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ro": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "ru": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sk": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sl": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sv": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "sw": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "th": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "tr": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "uk": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "vi": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "zh-CN": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" }, "zh-TW": { "articleCount": 15, "authorCount": 3, "authors": [ { "authorId": "507f1f77bcf86cd799439011", "avatarUrl": "https://example.com/avatar.png", "name": "John Doe" } ], "description": "A collection of articles", "externalUrl": "https://help.yourdomain.com/en/collections/3416135-english-collection", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/collections/3416135-english-collection", "name": "English Collection", "slug": "3416135-english-collection" } } } ``` ## Delete a collection **delete** `/v2/help_center/collections/{id}` Deletes an existing collection. ### Path Parameters - `id` - The unique identifier of the collection to delete ### Response Returns a deletion confirmation object: - `id` - The ID of the deleted collection - `object` - Always "collection" - `deleted` - Always true ### Errors - `404` - Collection not found in your organization's help center ### Path Parameters - `id: string` The collection unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `id: string` Unique identifier of the deleted collection - `deleted: true` Indicates the resource was deleted - `true` - `object: "collection"` Object type identifier - `"collection"` ### Example ```http curl https://do.featurebase.app/v2/help_center/collections/$ID \ -X DELETE \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "id": "3416135", "deleted": true, "object": "collection" } ``` ## Domain Types ### Collection - `Collection object { id, availableLocales, createdAt, 19 more }` - `id: string` Collection unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `helpCenterId: string` Help center ID - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "collection"` Object type identifier - `"collection"` - `organization: string` Organization ID - `parentId: string` Parent collection ID - `updatedAt: string` ISO 8601 timestamp when last updated - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `collapseSidebar: optional boolean` Whether to collapse sidebar - `defaultLocale: optional "bn" or "bs" or "pt-BR" or 39 more` Default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `icon: optional object { type, value }` Collection icon - `type: string` Icon type - `value: string` Icon value - `name: optional string` Collection name - `order: optional number` Display order - `path: optional string` Collection path - `slug: optional string` URL slug - `translations: optional object { id, bg, bn, 39 more }` Translations by locale code - `id: optional CollectionTranslation` - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `authors: optional array of object { authorId, avatarUrl, name }` List of authors - `authorId: optional string` Author ID - `avatarUrl: optional string` Author avatar URL - `name: optional string` Author name - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `name: optional string` Collection name - `slug: optional string` URL slug - `bg: optional CollectionTranslation` - `bn: optional CollectionTranslation` - `bs: optional CollectionTranslation` - `ca: optional CollectionTranslation` - `cs: optional CollectionTranslation` - `da: optional CollectionTranslation` - `de: optional CollectionTranslation` - `el: optional CollectionTranslation` - `en: optional CollectionTranslation` - `es: optional CollectionTranslation` - `et: optional CollectionTranslation` - `fi: optional CollectionTranslation` - `fr: optional CollectionTranslation` - `hi: optional CollectionTranslation` - `hr: optional CollectionTranslation` - `hu: optional CollectionTranslation` - `it: optional CollectionTranslation` - `ja: optional CollectionTranslation` - `ko: optional CollectionTranslation` - `lt: optional CollectionTranslation` - `lv: optional CollectionTranslation` - `mn: optional CollectionTranslation` - `ms: optional CollectionTranslation` - `nb: optional CollectionTranslation` - `nl: optional CollectionTranslation` - `pl: optional CollectionTranslation` - `pt: optional CollectionTranslation` - `"pt-BR": optional CollectionTranslation` - `ro: optional CollectionTranslation` - `ru: optional CollectionTranslation` - `sk: optional CollectionTranslation` - `sl: optional CollectionTranslation` - `sr: optional CollectionTranslation` - `sv: optional CollectionTranslation` - `sw: optional CollectionTranslation` - `th: optional CollectionTranslation` - `tr: optional CollectionTranslation` - `uk: optional CollectionTranslation` - `vi: optional CollectionTranslation` - `"zh-CN": optional CollectionTranslation` - `"zh-TW": optional CollectionTranslation` ### Collection Icon Nova - `CollectionIconNova object { type, value }` An updated icon object for the collection - `type: "emoji" or "predefined"` Icon type (e.g., "emoji") - `"emoji"` - `"predefined"` - `value: string` Icon value ### Collection Translation - `CollectionTranslation object { articleCount, authorCount, authors, 5 more }` - `articleCount: optional number` Number of articles - `authorCount: optional number` Number of authors - `authors: optional array of object { authorId, avatarUrl, name }` List of authors - `authorId: optional string` Author ID - `avatarUrl: optional string` Author avatar URL - `name: optional string` Author name - `description: optional string` Collection description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `name: optional string` Collection name - `slug: optional string` URL slug ### Collection Translation Input Nova - `CollectionTranslationInputNova object { description, name }` - `description: optional string` Collection description in this locale - `name: optional string` Collection name in this locale ### Collection Delete Response - `CollectionDeleteResponse object { id, deleted, object }` - `id: string` Unique identifier of the deleted collection - `deleted: true` Indicates the resource was deleted - `true` - `object: "collection"` Object type identifier - `"collection"` # Articles ## List articles **get** `/v2/help_center/articles` Returns a paginated list of articles within your organization's help center. Articles are the main content pieces that contain documentation, guides, and FAQs. ### Query Parameters - `limit` - Number of items to return (1-100, default 10) - `cursor` - Cursor for pagination - `state` - Filter by article state: "live", "draft", or "all" (default "live") - `parentId` - Filter by parent collection ID ### Response Format Returns a list object with: - `object` - Always "list" - `data` - Array of article objects - `nextCursor` - Cursor for next page (null if no more results) ### Article Object Each article includes: - `id` - Unique identifier - `title` - Article title - `description` - Article description - `body` - Article content (HTML) - `slug` - URL slug - `icon` - Article icon (emoji or custom) - `parentId` - Parent collection ID - `helpCenterId` - ID of the help center this article belongs to - `organization` - Organization ID - `state` - Article state (live or draft) - `defaultLocale` - Default locale for content - `locale` - Current locale - `availableLocales` - Array of available locales - `publishedLocales` - Array of locales where article is published - `featurebaseUrl` - Featurebase URL for the article - `externalUrl` - External URL if custom domain is configured - `author` - Author information (name, authorId, avatarUrl) - `order` - Display order - `isPublished` - Whether the article is published - `isDraftDiffersFromLive` - Whether draft differs from live version - `translations` - Translations for different locales - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated ### Query Parameters - `cursor: optional string` An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page of results. - `helpCenterId: optional string` Filter articles by help center ID. If omitted, returns articles across all help centers. - `limit: optional number` A limit on the number of objects to be returned, between 1 and 100. - `parentId: optional string` Filter articles by parent collection ID - `state: optional "live" or "draft" or "all"` Filter articles by state. Use "all" to get both draft and live articles. - `"live"` - `"draft"` - `"all"` ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `data: array of Article` Array of article objects - `id: string` Article unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `helpCenterId: string` Help Center ID - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "article"` Object type identifier - `"article"` - `organization: string` Organization ID - `state: "live" or "draft"` Article state - `"live"` - `"draft"` - `updatedAt: string` ISO 8601 timestamp when last updated - `author: optional ArticleAuthor` Article author - `authorId: string` Author user ID - `name: string` Author name - `avatarUrl: optional string` Author avatar URL - `body: optional string` Article body content (HTML) - `defaultLocale: optional "bn" or "bs" or "pt-BR" or 39 more` Default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `icon: optional object { type, value }` Article icon - `type: "emoji" or "custom"` Icon type - `"emoji"` - `"custom"` - `value: string` Icon value (emoji or URL) - `isDraftDiffersFromLive: optional boolean` Whether draft differs from live - `isPublished: optional boolean` Whether the article is published - `liveUpdatedAt: optional string` ISO 8601 timestamp when live version was last updated - `order: optional number` Display order - `parentId: optional string` Parent collection ID - `path: optional string` Path to article within help center hierarchy - `publishedLocales: optional array of "bn" or "bs" or "pt-BR" or 39 more` Published locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `slug: optional string` URL slug - `surveyId: optional string` Associated survey ID - `title: optional string` Article title - `translationCreatedAt: optional string` ISO 8601 timestamp when translation was created - `translations: optional object { id, bg, bn, 39 more }` Translations by locale code - `id: optional ArticleTranslation` - `author: optional ArticleAuthor` Article author - `body: optional string` Article body content (HTML) - `createdAt: optional string` ISO 8601 timestamp when translation was created - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `slug: optional string` URL slug - `title: optional string` Article title - `updatedAt: optional string` ISO 8601 timestamp when translation was last updated - `bg: optional ArticleTranslation` - `bn: optional ArticleTranslation` - `bs: optional ArticleTranslation` - `ca: optional ArticleTranslation` - `cs: optional ArticleTranslation` - `da: optional ArticleTranslation` - `de: optional ArticleTranslation` - `el: optional ArticleTranslation` - `en: optional ArticleTranslation` - `es: optional ArticleTranslation` - `et: optional ArticleTranslation` - `fi: optional ArticleTranslation` - `fr: optional ArticleTranslation` - `hi: optional ArticleTranslation` - `hr: optional ArticleTranslation` - `hu: optional ArticleTranslation` - `it: optional ArticleTranslation` - `ja: optional ArticleTranslation` - `ko: optional ArticleTranslation` - `lt: optional ArticleTranslation` - `lv: optional ArticleTranslation` - `mn: optional ArticleTranslation` - `ms: optional ArticleTranslation` - `nb: optional ArticleTranslation` - `nl: optional ArticleTranslation` - `pl: optional ArticleTranslation` - `pt: optional ArticleTranslation` - `"pt-BR": optional ArticleTranslation` - `ro: optional ArticleTranslation` - `ru: optional ArticleTranslation` - `sk: optional ArticleTranslation` - `sl: optional ArticleTranslation` - `sr: optional ArticleTranslation` - `sv: optional ArticleTranslation` - `sw: optional ArticleTranslation` - `th: optional ArticleTranslation` - `tr: optional ArticleTranslation` - `uk: optional ArticleTranslation` - `vi: optional ArticleTranslation` - `"zh-CN": optional ArticleTranslation` - `"zh-TW": optional ArticleTranslation` - `translationUpdatedAt: optional string` ISO 8601 timestamp when translation was last updated - `visibleBy: optional array of string` Visibility settings - `nextCursor: string` Cursor for fetching the next page (cursor-based pagination) - `object: "list"` Object type identifier - `"list"` ### Example ```http curl https://do.featurebase.app/v2/help_center/articles \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "data": [ { "id": "1234567", "availableLocales": [ "en", "de" ], "createdAt": "2024-10-18T12:33:09.099Z", "helpCenterId": "j7c5g8ah3ewxp4lo", "locale": "en", "object": "article", "organization": "6595518396205e06b897ad65", "state": "live", "updatedAt": "2024-10-18T13:03:25.921Z", "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "defaultLocale": "en", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "icon": { "type": "emoji", "value": "📖" }, "isDraftDiffersFromLive": false, "isPublished": true, "liveUpdatedAt": "2024-10-18T13:03:25.921Z", "order": 1, "parentId": "6474684", "path": "/getting-started", "publishedLocales": [ "en" ], "slug": "1234567-getting-started-guide", "surveyId": "6743752ca81ae59d25cf834b", "title": "Getting Started Guide", "translationCreatedAt": "2024-10-18T12:33:09.099Z", "translations": { "id": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bg": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bn": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bs": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ca": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "cs": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "da": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "de": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "el": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "en": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "es": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "et": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "fi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "fr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hu": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "it": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ja": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ko": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "lt": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "lv": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "mn": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ms": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "nb": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "nl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pt": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pt-BR": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ro": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ru": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sk": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sv": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sw": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "th": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "tr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "uk": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "vi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "zh-CN": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "zh-TW": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" } }, "translationUpdatedAt": "2024-10-19T14:22:15.123Z", "visibleBy": [ "everyone" ] } ], "nextCursor": "eyJpZCI6IjY3NDM3NTJjYTgxYWU1OWQyNWNmODM0YiJ9", "object": "list" } ``` ## Create an article **post** `/v2/help_center/articles` Creates a new article in your organization's help center. ### Request Body Required attributes: - `title` - The title of the article Optional attributes: - `description` - A brief description of the article - `body` - The HTML content of the article (supports external image URLs and base64 data URIs) - `formatter` - Content formatter: "default" or "ai" (AI converts markdown/html to Featurebase format) - `parentId` - The ID of the parent collection - `icon` - Icon object with type and value - `state` - "live" or "draft" (defaults to "draft") - `translations` - Dictionary of translations keyed by locale ### Response Returns the created article object with: - `id` - Unique identifier - `title` - Article title - `description` - Article description - `body` - Article content (HTML) - `slug` - URL slug - `icon` - Article icon (emoji or custom) - `parentId` - Parent collection ID - `helpCenterId` - ID of the help center this article belongs to - `organization` - Organization ID - `state` - Article state (live or draft) - `author` - Author information (name, authorId, avatarUrl) - `translations` - Translations for different locales - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `title: string` The title of the article - `body: optional string` The HTML content of the article (supports external image URLs and base64 data URIs) - `description: optional string` A brief description of the article - `formatter: optional "default" or "ai"` Content formatter - "ai" converts markdown/html to Featurebase format using AI - `"default"` - `"ai"` - `icon: optional ArticleIconInputNova` Icon object for the article - `type: "emoji" or "predefined"` Type of icon (emoji or predefined only) - `"emoji"` - `"predefined"` - `value: string` Icon value - `parentId: optional string` The ID of the parent collection - `state: optional "live" or "draft"` Article state - "live" publishes immediately, "draft" saves as draft - `"live"` - `"draft"` - `translations: optional object { id, bg, bn, 39 more }` Dictionary of translations keyed by locale code - `id: optional ArticleTranslationInputNova` - `body: optional string` Article body content in this locale (HTML or markdown) - `description: optional string` Article description in this locale - `title: optional string` Article title in this locale - `bg: optional ArticleTranslationInputNova` - `bn: optional ArticleTranslationInputNova` - `bs: optional ArticleTranslationInputNova` - `ca: optional ArticleTranslationInputNova` - `cs: optional ArticleTranslationInputNova` - `da: optional ArticleTranslationInputNova` - `de: optional ArticleTranslationInputNova` - `el: optional ArticleTranslationInputNova` - `en: optional ArticleTranslationInputNova` - `es: optional ArticleTranslationInputNova` - `et: optional ArticleTranslationInputNova` - `fi: optional ArticleTranslationInputNova` - `fr: optional ArticleTranslationInputNova` - `hi: optional ArticleTranslationInputNova` - `hr: optional ArticleTranslationInputNova` - `hu: optional ArticleTranslationInputNova` - `it: optional ArticleTranslationInputNova` - `ja: optional ArticleTranslationInputNova` - `ko: optional ArticleTranslationInputNova` - `lt: optional ArticleTranslationInputNova` - `lv: optional ArticleTranslationInputNova` - `mn: optional ArticleTranslationInputNova` - `ms: optional ArticleTranslationInputNova` - `nb: optional ArticleTranslationInputNova` - `nl: optional ArticleTranslationInputNova` - `pl: optional ArticleTranslationInputNova` - `pt: optional ArticleTranslationInputNova` - `"pt-BR": optional ArticleTranslationInputNova` - `ro: optional ArticleTranslationInputNova` - `ru: optional ArticleTranslationInputNova` - `sk: optional ArticleTranslationInputNova` - `sl: optional ArticleTranslationInputNova` - `sr: optional ArticleTranslationInputNova` - `sv: optional ArticleTranslationInputNova` - `sw: optional ArticleTranslationInputNova` - `th: optional ArticleTranslationInputNova` - `tr: optional ArticleTranslationInputNova` - `uk: optional ArticleTranslationInputNova` - `vi: optional ArticleTranslationInputNova` - `"zh-CN": optional ArticleTranslationInputNova` - `"zh-TW": optional ArticleTranslationInputNova` ### Returns - `Article object { id, availableLocales, createdAt, 27 more }` - `id: string` Article unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `helpCenterId: string` Help Center ID - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "article"` Object type identifier - `"article"` - `organization: string` Organization ID - `state: "live" or "draft"` Article state - `"live"` - `"draft"` - `updatedAt: string` ISO 8601 timestamp when last updated - `author: optional ArticleAuthor` Article author - `authorId: string` Author user ID - `name: string` Author name - `avatarUrl: optional string` Author avatar URL - `body: optional string` Article body content (HTML) - `defaultLocale: optional "bn" or "bs" or "pt-BR" or 39 more` Default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `icon: optional object { type, value }` Article icon - `type: "emoji" or "custom"` Icon type - `"emoji"` - `"custom"` - `value: string` Icon value (emoji or URL) - `isDraftDiffersFromLive: optional boolean` Whether draft differs from live - `isPublished: optional boolean` Whether the article is published - `liveUpdatedAt: optional string` ISO 8601 timestamp when live version was last updated - `order: optional number` Display order - `parentId: optional string` Parent collection ID - `path: optional string` Path to article within help center hierarchy - `publishedLocales: optional array of "bn" or "bs" or "pt-BR" or 39 more` Published locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `slug: optional string` URL slug - `surveyId: optional string` Associated survey ID - `title: optional string` Article title - `translationCreatedAt: optional string` ISO 8601 timestamp when translation was created - `translations: optional object { id, bg, bn, 39 more }` Translations by locale code - `id: optional ArticleTranslation` - `author: optional ArticleAuthor` Article author - `body: optional string` Article body content (HTML) - `createdAt: optional string` ISO 8601 timestamp when translation was created - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `slug: optional string` URL slug - `title: optional string` Article title - `updatedAt: optional string` ISO 8601 timestamp when translation was last updated - `bg: optional ArticleTranslation` - `bn: optional ArticleTranslation` - `bs: optional ArticleTranslation` - `ca: optional ArticleTranslation` - `cs: optional ArticleTranslation` - `da: optional ArticleTranslation` - `de: optional ArticleTranslation` - `el: optional ArticleTranslation` - `en: optional ArticleTranslation` - `es: optional ArticleTranslation` - `et: optional ArticleTranslation` - `fi: optional ArticleTranslation` - `fr: optional ArticleTranslation` - `hi: optional ArticleTranslation` - `hr: optional ArticleTranslation` - `hu: optional ArticleTranslation` - `it: optional ArticleTranslation` - `ja: optional ArticleTranslation` - `ko: optional ArticleTranslation` - `lt: optional ArticleTranslation` - `lv: optional ArticleTranslation` - `mn: optional ArticleTranslation` - `ms: optional ArticleTranslation` - `nb: optional ArticleTranslation` - `nl: optional ArticleTranslation` - `pl: optional ArticleTranslation` - `pt: optional ArticleTranslation` - `"pt-BR": optional ArticleTranslation` - `ro: optional ArticleTranslation` - `ru: optional ArticleTranslation` - `sk: optional ArticleTranslation` - `sl: optional ArticleTranslation` - `sr: optional ArticleTranslation` - `sv: optional ArticleTranslation` - `sw: optional ArticleTranslation` - `th: optional ArticleTranslation` - `tr: optional ArticleTranslation` - `uk: optional ArticleTranslation` - `vi: optional ArticleTranslation` - `"zh-CN": optional ArticleTranslation` - `"zh-TW": optional ArticleTranslation` - `translationUpdatedAt: optional string` ISO 8601 timestamp when translation was last updated - `visibleBy: optional array of string` Visibility settings ### Example ```http curl https://do.featurebase.app/v2/help_center/articles \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "title": "Getting Started Guide", "body": "

Welcome to our getting started guide.

", "description": "Learn how to get started with our platform", "formatter": "default", "parentId": "6474684", "state": "draft" }' ``` #### Response ```json { "id": "1234567", "availableLocales": [ "en", "de" ], "createdAt": "2024-10-18T12:33:09.099Z", "helpCenterId": "j7c5g8ah3ewxp4lo", "locale": "en", "object": "article", "organization": "6595518396205e06b897ad65", "state": "live", "updatedAt": "2024-10-18T13:03:25.921Z", "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "defaultLocale": "en", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "icon": { "type": "emoji", "value": "📖" }, "isDraftDiffersFromLive": false, "isPublished": true, "liveUpdatedAt": "2024-10-18T13:03:25.921Z", "order": 1, "parentId": "6474684", "path": "/getting-started", "publishedLocales": [ "en" ], "slug": "1234567-getting-started-guide", "surveyId": "6743752ca81ae59d25cf834b", "title": "Getting Started Guide", "translationCreatedAt": "2024-10-18T12:33:09.099Z", "translations": { "id": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bg": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bn": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bs": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ca": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "cs": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "da": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "de": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "el": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "en": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "es": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "et": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "fi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "fr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hu": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "it": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ja": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ko": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "lt": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "lv": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "mn": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ms": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "nb": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "nl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pt": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pt-BR": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ro": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ru": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sk": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sv": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sw": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "th": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "tr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "uk": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "vi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "zh-CN": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "zh-TW": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" } }, "translationUpdatedAt": "2024-10-19T14:22:15.123Z", "visibleBy": [ "everyone" ] } ``` ## Get an article by ID **get** `/v2/help_center/articles/{id}` Retrieves a specific article by its unique identifier. Returns the article object if found in your organization's help center. ### Query Parameters - `state` - Article state to retrieve: "live" or "draft" (default "live") ### Response Returns an article object with: - `id` - Unique identifier - `title` - Article title - `description` - Article description - `body` - Article content (HTML) - `slug` - URL slug - `icon` - Article icon (emoji or custom) - `parentId` - Parent collection ID - `helpCenterId` - ID of the help center this article belongs to - `organization` - Organization ID - `state` - Article state (live or draft) - `defaultLocale` - Default locale for content - `locale` - Current locale - `availableLocales` - Array of available locales - `publishedLocales` - Array of locales where article is published - `featurebaseUrl` - Featurebase URL for the article - `externalUrl` - External URL if custom domain is configured - `author` - Author information (name, authorId, avatarUrl) - `order` - Display order - `isPublished` - Whether the article is published - `isDraftDiffersFromLive` - Whether draft differs from live version - `translations` - Translations for different locales - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated - `liveUpdatedAt` - ISO 8601 timestamp when live version was last updated ### Errors - `404` - Article not found in your organization's help center ### Path Parameters - `id: string` Article unique identifier ### Query Parameters - `state: optional "live" or "draft"` Article state to retrieve - `"live"` - `"draft"` ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `Article object { id, availableLocales, createdAt, 27 more }` - `id: string` Article unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `helpCenterId: string` Help Center ID - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "article"` Object type identifier - `"article"` - `organization: string` Organization ID - `state: "live" or "draft"` Article state - `"live"` - `"draft"` - `updatedAt: string` ISO 8601 timestamp when last updated - `author: optional ArticleAuthor` Article author - `authorId: string` Author user ID - `name: string` Author name - `avatarUrl: optional string` Author avatar URL - `body: optional string` Article body content (HTML) - `defaultLocale: optional "bn" or "bs" or "pt-BR" or 39 more` Default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `icon: optional object { type, value }` Article icon - `type: "emoji" or "custom"` Icon type - `"emoji"` - `"custom"` - `value: string` Icon value (emoji or URL) - `isDraftDiffersFromLive: optional boolean` Whether draft differs from live - `isPublished: optional boolean` Whether the article is published - `liveUpdatedAt: optional string` ISO 8601 timestamp when live version was last updated - `order: optional number` Display order - `parentId: optional string` Parent collection ID - `path: optional string` Path to article within help center hierarchy - `publishedLocales: optional array of "bn" or "bs" or "pt-BR" or 39 more` Published locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `slug: optional string` URL slug - `surveyId: optional string` Associated survey ID - `title: optional string` Article title - `translationCreatedAt: optional string` ISO 8601 timestamp when translation was created - `translations: optional object { id, bg, bn, 39 more }` Translations by locale code - `id: optional ArticleTranslation` - `author: optional ArticleAuthor` Article author - `body: optional string` Article body content (HTML) - `createdAt: optional string` ISO 8601 timestamp when translation was created - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `slug: optional string` URL slug - `title: optional string` Article title - `updatedAt: optional string` ISO 8601 timestamp when translation was last updated - `bg: optional ArticleTranslation` - `bn: optional ArticleTranslation` - `bs: optional ArticleTranslation` - `ca: optional ArticleTranslation` - `cs: optional ArticleTranslation` - `da: optional ArticleTranslation` - `de: optional ArticleTranslation` - `el: optional ArticleTranslation` - `en: optional ArticleTranslation` - `es: optional ArticleTranslation` - `et: optional ArticleTranslation` - `fi: optional ArticleTranslation` - `fr: optional ArticleTranslation` - `hi: optional ArticleTranslation` - `hr: optional ArticleTranslation` - `hu: optional ArticleTranslation` - `it: optional ArticleTranslation` - `ja: optional ArticleTranslation` - `ko: optional ArticleTranslation` - `lt: optional ArticleTranslation` - `lv: optional ArticleTranslation` - `mn: optional ArticleTranslation` - `ms: optional ArticleTranslation` - `nb: optional ArticleTranslation` - `nl: optional ArticleTranslation` - `pl: optional ArticleTranslation` - `pt: optional ArticleTranslation` - `"pt-BR": optional ArticleTranslation` - `ro: optional ArticleTranslation` - `ru: optional ArticleTranslation` - `sk: optional ArticleTranslation` - `sl: optional ArticleTranslation` - `sr: optional ArticleTranslation` - `sv: optional ArticleTranslation` - `sw: optional ArticleTranslation` - `th: optional ArticleTranslation` - `tr: optional ArticleTranslation` - `uk: optional ArticleTranslation` - `vi: optional ArticleTranslation` - `"zh-CN": optional ArticleTranslation` - `"zh-TW": optional ArticleTranslation` - `translationUpdatedAt: optional string` ISO 8601 timestamp when translation was last updated - `visibleBy: optional array of string` Visibility settings ### Example ```http curl https://do.featurebase.app/v2/help_center/articles/$ID \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "id": "1234567", "availableLocales": [ "en", "de" ], "createdAt": "2024-10-18T12:33:09.099Z", "helpCenterId": "j7c5g8ah3ewxp4lo", "locale": "en", "object": "article", "organization": "6595518396205e06b897ad65", "state": "live", "updatedAt": "2024-10-18T13:03:25.921Z", "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "defaultLocale": "en", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "icon": { "type": "emoji", "value": "📖" }, "isDraftDiffersFromLive": false, "isPublished": true, "liveUpdatedAt": "2024-10-18T13:03:25.921Z", "order": 1, "parentId": "6474684", "path": "/getting-started", "publishedLocales": [ "en" ], "slug": "1234567-getting-started-guide", "surveyId": "6743752ca81ae59d25cf834b", "title": "Getting Started Guide", "translationCreatedAt": "2024-10-18T12:33:09.099Z", "translations": { "id": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bg": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bn": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bs": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ca": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "cs": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "da": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "de": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "el": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "en": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "es": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "et": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "fi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "fr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hu": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "it": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ja": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ko": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "lt": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "lv": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "mn": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ms": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "nb": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "nl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pt": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pt-BR": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ro": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ru": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sk": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sv": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sw": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "th": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "tr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "uk": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "vi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "zh-CN": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "zh-TW": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" } }, "translationUpdatedAt": "2024-10-19T14:22:15.123Z", "visibleBy": [ "everyone" ] } ``` ## Update an article **patch** `/v2/help_center/articles/{id}` Updates an existing article. Only include the fields you wish to update. ### Path Parameters - `id` - The unique identifier of the article to update ### Request Body All fields are optional. Only provided fields will be updated: - `title` - The new title of the article - `description` - The new description of the article - `body` - The new HTML content of the article - `formatter` - Content formatter: "default" or "ai" - `icon` - Updated icon object for the article - `parentId` - New parent collection ID - `authorId` - ID of the new author (must be a member of the organization) - `state` - "live" or "draft" - if "live", publishes immediately - `translations` - Dictionary of updated translations keyed by locale ### Response Returns the updated article object with: - `id` - Unique identifier - `title` - Article title - `description` - Article description - `body` - Article content (HTML) - `slug` - URL slug - `icon` - Article icon (emoji or custom) - `parentId` - Parent collection ID - `helpCenterId` - ID of the help center this article belongs to - `organization` - Organization ID - `state` - Article state (live or draft) - `author` - Author information (name, authorId, avatarUrl) - `translations` - Translations for different locales - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Errors - `404` - Article not found in your organization's help center ### Path Parameters - `id: string` The article unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `authorId: optional string` ID of the new author (must be a member of the organization) - `body: optional string` The new HTML content of the article - `description: optional string` The new description of the article - `formatter: optional "default" or "ai"` Content formatter - `"default"` - `"ai"` - `icon: optional ArticleIconInputNova` Icon object for the article - `type: "emoji" or "predefined"` Type of icon (emoji or predefined only) - `"emoji"` - `"predefined"` - `value: string` Icon value - `parentId: optional string` New parent collection ID - `state: optional "live" or "draft"` Article state - if "live", publishes immediately - `"live"` - `"draft"` - `title: optional string` The new title of the article - `translations: optional object { id, bg, bn, 39 more }` Dictionary of updated translations keyed by locale code - `id: optional ArticleTranslationInputNova` - `body: optional string` Article body content in this locale (HTML or markdown) - `description: optional string` Article description in this locale - `title: optional string` Article title in this locale - `bg: optional ArticleTranslationInputNova` - `bn: optional ArticleTranslationInputNova` - `bs: optional ArticleTranslationInputNova` - `ca: optional ArticleTranslationInputNova` - `cs: optional ArticleTranslationInputNova` - `da: optional ArticleTranslationInputNova` - `de: optional ArticleTranslationInputNova` - `el: optional ArticleTranslationInputNova` - `en: optional ArticleTranslationInputNova` - `es: optional ArticleTranslationInputNova` - `et: optional ArticleTranslationInputNova` - `fi: optional ArticleTranslationInputNova` - `fr: optional ArticleTranslationInputNova` - `hi: optional ArticleTranslationInputNova` - `hr: optional ArticleTranslationInputNova` - `hu: optional ArticleTranslationInputNova` - `it: optional ArticleTranslationInputNova` - `ja: optional ArticleTranslationInputNova` - `ko: optional ArticleTranslationInputNova` - `lt: optional ArticleTranslationInputNova` - `lv: optional ArticleTranslationInputNova` - `mn: optional ArticleTranslationInputNova` - `ms: optional ArticleTranslationInputNova` - `nb: optional ArticleTranslationInputNova` - `nl: optional ArticleTranslationInputNova` - `pl: optional ArticleTranslationInputNova` - `pt: optional ArticleTranslationInputNova` - `"pt-BR": optional ArticleTranslationInputNova` - `ro: optional ArticleTranslationInputNova` - `ru: optional ArticleTranslationInputNova` - `sk: optional ArticleTranslationInputNova` - `sl: optional ArticleTranslationInputNova` - `sr: optional ArticleTranslationInputNova` - `sv: optional ArticleTranslationInputNova` - `sw: optional ArticleTranslationInputNova` - `th: optional ArticleTranslationInputNova` - `tr: optional ArticleTranslationInputNova` - `uk: optional ArticleTranslationInputNova` - `vi: optional ArticleTranslationInputNova` - `"zh-CN": optional ArticleTranslationInputNova` - `"zh-TW": optional ArticleTranslationInputNova` ### Returns - `Article object { id, availableLocales, createdAt, 27 more }` - `id: string` Article unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `helpCenterId: string` Help Center ID - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "article"` Object type identifier - `"article"` - `organization: string` Organization ID - `state: "live" or "draft"` Article state - `"live"` - `"draft"` - `updatedAt: string` ISO 8601 timestamp when last updated - `author: optional ArticleAuthor` Article author - `authorId: string` Author user ID - `name: string` Author name - `avatarUrl: optional string` Author avatar URL - `body: optional string` Article body content (HTML) - `defaultLocale: optional "bn" or "bs" or "pt-BR" or 39 more` Default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `icon: optional object { type, value }` Article icon - `type: "emoji" or "custom"` Icon type - `"emoji"` - `"custom"` - `value: string` Icon value (emoji or URL) - `isDraftDiffersFromLive: optional boolean` Whether draft differs from live - `isPublished: optional boolean` Whether the article is published - `liveUpdatedAt: optional string` ISO 8601 timestamp when live version was last updated - `order: optional number` Display order - `parentId: optional string` Parent collection ID - `path: optional string` Path to article within help center hierarchy - `publishedLocales: optional array of "bn" or "bs" or "pt-BR" or 39 more` Published locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `slug: optional string` URL slug - `surveyId: optional string` Associated survey ID - `title: optional string` Article title - `translationCreatedAt: optional string` ISO 8601 timestamp when translation was created - `translations: optional object { id, bg, bn, 39 more }` Translations by locale code - `id: optional ArticleTranslation` - `author: optional ArticleAuthor` Article author - `body: optional string` Article body content (HTML) - `createdAt: optional string` ISO 8601 timestamp when translation was created - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `slug: optional string` URL slug - `title: optional string` Article title - `updatedAt: optional string` ISO 8601 timestamp when translation was last updated - `bg: optional ArticleTranslation` - `bn: optional ArticleTranslation` - `bs: optional ArticleTranslation` - `ca: optional ArticleTranslation` - `cs: optional ArticleTranslation` - `da: optional ArticleTranslation` - `de: optional ArticleTranslation` - `el: optional ArticleTranslation` - `en: optional ArticleTranslation` - `es: optional ArticleTranslation` - `et: optional ArticleTranslation` - `fi: optional ArticleTranslation` - `fr: optional ArticleTranslation` - `hi: optional ArticleTranslation` - `hr: optional ArticleTranslation` - `hu: optional ArticleTranslation` - `it: optional ArticleTranslation` - `ja: optional ArticleTranslation` - `ko: optional ArticleTranslation` - `lt: optional ArticleTranslation` - `lv: optional ArticleTranslation` - `mn: optional ArticleTranslation` - `ms: optional ArticleTranslation` - `nb: optional ArticleTranslation` - `nl: optional ArticleTranslation` - `pl: optional ArticleTranslation` - `pt: optional ArticleTranslation` - `"pt-BR": optional ArticleTranslation` - `ro: optional ArticleTranslation` - `ru: optional ArticleTranslation` - `sk: optional ArticleTranslation` - `sl: optional ArticleTranslation` - `sr: optional ArticleTranslation` - `sv: optional ArticleTranslation` - `sw: optional ArticleTranslation` - `th: optional ArticleTranslation` - `tr: optional ArticleTranslation` - `uk: optional ArticleTranslation` - `vi: optional ArticleTranslation` - `"zh-CN": optional ArticleTranslation` - `"zh-TW": optional ArticleTranslation` - `translationUpdatedAt: optional string` ISO 8601 timestamp when translation was last updated - `visibleBy: optional array of string` Visibility settings ### Example ```http curl https://do.featurebase.app/v2/help_center/articles/$ID \ -X PATCH \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "authorId": "507f1f77bcf86cd799439011", "body": "

Updated content.

", "description": "Updated description", "formatter": "default", "parentId": "6474684", "state": "live", "title": "Updated Getting Started Guide" }' ``` #### Response ```json { "id": "1234567", "availableLocales": [ "en", "de" ], "createdAt": "2024-10-18T12:33:09.099Z", "helpCenterId": "j7c5g8ah3ewxp4lo", "locale": "en", "object": "article", "organization": "6595518396205e06b897ad65", "state": "live", "updatedAt": "2024-10-18T13:03:25.921Z", "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "defaultLocale": "en", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "icon": { "type": "emoji", "value": "📖" }, "isDraftDiffersFromLive": false, "isPublished": true, "liveUpdatedAt": "2024-10-18T13:03:25.921Z", "order": 1, "parentId": "6474684", "path": "/getting-started", "publishedLocales": [ "en" ], "slug": "1234567-getting-started-guide", "surveyId": "6743752ca81ae59d25cf834b", "title": "Getting Started Guide", "translationCreatedAt": "2024-10-18T12:33:09.099Z", "translations": { "id": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bg": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bn": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "bs": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ca": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "cs": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "da": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "de": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "el": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "en": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "es": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "et": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "fi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "fr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "hu": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "it": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ja": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ko": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "lt": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "lv": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "mn": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ms": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "nb": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "nl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pt": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "pt-BR": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ro": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "ru": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sk": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sl": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sv": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "sw": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "th": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "tr": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "uk": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "vi": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "zh-CN": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" }, "zh-TW": { "author": { "authorId": "507f1f77bcf86cd799439011", "name": "John Doe", "avatarUrl": null }, "body": "

Welcome to our guide.

", "createdAt": "2024-10-18T12:33:09.099Z", "description": "Learn how to get started", "externalUrl": "https://help.yourdomain.com/en/articles/1234567-getting-started-guide", "featurebaseUrl": "https://yourorg.featurebase.app/en/help/articles/1234567-getting-started-guide", "slug": "1234567-getting-started-guide", "title": "Getting Started Guide", "updatedAt": "2024-10-19T14:22:15.123Z" } }, "translationUpdatedAt": "2024-10-19T14:22:15.123Z", "visibleBy": [ "everyone" ] } ``` ## Delete an article **delete** `/v2/help_center/articles/{id}` Deletes an existing article. ### Path Parameters - `id` - The unique identifier of the article to delete ### Response Returns a deletion confirmation object: - `id` - The ID of the deleted article - `object` - Always "article" - `deleted` - Always true ### Errors - `404` - Article not found in your organization's help center ### Path Parameters - `id: string` The article unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `id: string` Unique identifier of the deleted article - `deleted: true` Indicates the resource was deleted - `true` - `object: "article"` Object type identifier - `"article"` ### Example ```http curl https://do.featurebase.app/v2/help_center/articles/$ID \ -X DELETE \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "id": "1234567", "deleted": true, "object": "article" } ``` ## Domain Types ### Article - `Article object { id, availableLocales, createdAt, 27 more }` - `id: string` Article unique identifier - `availableLocales: array of "bn" or "bs" or "pt-BR" or 39 more` Available locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `createdAt: string` ISO 8601 timestamp when created - `helpCenterId: string` Help Center ID - `locale: "bn" or "bs" or "pt-BR" or 39 more` Current locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "article"` Object type identifier - `"article"` - `organization: string` Organization ID - `state: "live" or "draft"` Article state - `"live"` - `"draft"` - `updatedAt: string` ISO 8601 timestamp when last updated - `author: optional ArticleAuthor` Article author - `authorId: string` Author user ID - `name: string` Author name - `avatarUrl: optional string` Author avatar URL - `body: optional string` Article body content (HTML) - `defaultLocale: optional "bn" or "bs" or "pt-BR" or 39 more` Default locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `icon: optional object { type, value }` Article icon - `type: "emoji" or "custom"` Icon type - `"emoji"` - `"custom"` - `value: string` Icon value (emoji or URL) - `isDraftDiffersFromLive: optional boolean` Whether draft differs from live - `isPublished: optional boolean` Whether the article is published - `liveUpdatedAt: optional string` ISO 8601 timestamp when live version was last updated - `order: optional number` Display order - `parentId: optional string` Parent collection ID - `path: optional string` Path to article within help center hierarchy - `publishedLocales: optional array of "bn" or "bs" or "pt-BR" or 39 more` Published locales - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `slug: optional string` URL slug - `surveyId: optional string` Associated survey ID - `title: optional string` Article title - `translationCreatedAt: optional string` ISO 8601 timestamp when translation was created - `translations: optional object { id, bg, bn, 39 more }` Translations by locale code - `id: optional ArticleTranslation` - `author: optional ArticleAuthor` Article author - `body: optional string` Article body content (HTML) - `createdAt: optional string` ISO 8601 timestamp when translation was created - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `slug: optional string` URL slug - `title: optional string` Article title - `updatedAt: optional string` ISO 8601 timestamp when translation was last updated - `bg: optional ArticleTranslation` - `bn: optional ArticleTranslation` - `bs: optional ArticleTranslation` - `ca: optional ArticleTranslation` - `cs: optional ArticleTranslation` - `da: optional ArticleTranslation` - `de: optional ArticleTranslation` - `el: optional ArticleTranslation` - `en: optional ArticleTranslation` - `es: optional ArticleTranslation` - `et: optional ArticleTranslation` - `fi: optional ArticleTranslation` - `fr: optional ArticleTranslation` - `hi: optional ArticleTranslation` - `hr: optional ArticleTranslation` - `hu: optional ArticleTranslation` - `it: optional ArticleTranslation` - `ja: optional ArticleTranslation` - `ko: optional ArticleTranslation` - `lt: optional ArticleTranslation` - `lv: optional ArticleTranslation` - `mn: optional ArticleTranslation` - `ms: optional ArticleTranslation` - `nb: optional ArticleTranslation` - `nl: optional ArticleTranslation` - `pl: optional ArticleTranslation` - `pt: optional ArticleTranslation` - `"pt-BR": optional ArticleTranslation` - `ro: optional ArticleTranslation` - `ru: optional ArticleTranslation` - `sk: optional ArticleTranslation` - `sl: optional ArticleTranslation` - `sr: optional ArticleTranslation` - `sv: optional ArticleTranslation` - `sw: optional ArticleTranslation` - `th: optional ArticleTranslation` - `tr: optional ArticleTranslation` - `uk: optional ArticleTranslation` - `vi: optional ArticleTranslation` - `"zh-CN": optional ArticleTranslation` - `"zh-TW": optional ArticleTranslation` - `translationUpdatedAt: optional string` ISO 8601 timestamp when translation was last updated - `visibleBy: optional array of string` Visibility settings ### Article Author - `ArticleAuthor object { authorId, name, avatarUrl }` Article author - `authorId: string` Author user ID - `name: string` Author name - `avatarUrl: optional string` Author avatar URL ### Article Icon Input Nova - `ArticleIconInputNova object { type, value }` Icon object for the article - `type: "emoji" or "predefined"` Type of icon (emoji or predefined only) - `"emoji"` - `"predefined"` - `value: string` Icon value ### Article Translation - `ArticleTranslation object { author, body, createdAt, 6 more }` - `author: optional ArticleAuthor` Article author - `authorId: string` Author user ID - `name: string` Author name - `avatarUrl: optional string` Author avatar URL - `body: optional string` Article body content (HTML) - `createdAt: optional string` ISO 8601 timestamp when translation was created - `description: optional string` Article description - `externalUrl: optional string` External URL - `featurebaseUrl: optional string` Featurebase URL - `slug: optional string` URL slug - `title: optional string` Article title - `updatedAt: optional string` ISO 8601 timestamp when translation was last updated ### Article Translation Input Nova - `ArticleTranslationInputNova object { body, description, title }` - `body: optional string` Article body content in this locale (HTML or markdown) - `description: optional string` Article description in this locale - `title: optional string` Article title in this locale ### Article Delete Response - `ArticleDeleteResponse object { id, deleted, object }` - `id: string` Unique identifier of the deleted article - `deleted: true` Indicates the resource was deleted - `true` - `object: "article"` Object type identifier - `"article"` # Redirect Rules ## List redirect rules **get** `/v2/help_center/redirect_rules` Returns a paginated list of redirect rules within your organization. Redirect rules map old Help Center URLs to new article or collection destinations, enabling seamless migration from legacy help center systems. Only Help Centers with a custom domain configured support redirect rules. ### Query Parameters - `limit` - Number of items to return (1-100, default 10) - `cursor` - Cursor for pagination - `helpCenterId` - Filter by help center ID - `locale` - Filter by locale code - `targetType` - Filter by target type ("article" or "collection") ### Response Format Returns a list object with: - `object` - Always "list" - `data` - Array of redirect rule objects - `nextCursor` - Cursor for next page (null if no more results) ### Redirect Rule Object Each redirect rule includes: - `id` - Unique identifier (MongoDB ObjectId) - `helpCenterId` - Help center this rule belongs to - `locale` - Locale code used to resolve the target translation - `fromUrl` - Canonical source URL (query/hash stripped, hostname lowercased) - `targetType` - "article" or "collection" - `targetId` - ID of the target article or collection - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Query Parameters - `cursor: optional string` An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page. - `helpCenterId: optional string` Filter redirect rules by help center ID - `limit: optional number` A limit on the number of objects to be returned, between 1 and 100. - `locale: optional "bn" or "bs" or "pt-BR" or 39 more` Filter redirect rules by locale - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `targetType: optional "article" or "collection"` Filter redirect rules by target type - `"article"` - `"collection"` ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `data: array of RedirectRule` Array of redirect rules - `id: string` Redirect rule unique identifier - `createdAt: string` ISO 8601 timestamp when created - `fromUrl: string` Canonical source URL being redirected from (query and hash stripped) - `helpCenterId: string` Help center identifier - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale code for the redirect rule - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "redirect_rule"` Object type identifier - `"redirect_rule"` - `targetId: string` Target article or collection ID - `targetType: "article" or "collection"` Type of content the redirect points to - `"article"` - `"collection"` - `updatedAt: string` ISO 8601 timestamp when last updated - `nextCursor: string` Cursor for fetching the next page. Null if there are no more results. - `object: "list"` Object type identifier - `"list"` ### Example ```http curl https://do.featurebase.app/v2/help_center/redirect_rules \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "data": [ { "id": "507f1f77bcf86cd799439011", "createdAt": "2026-02-11T12:00:00.000Z", "fromUrl": "https://help.example.com/en/old/getting-started", "helpCenterId": "ox6qrqprmsuqaunj", "locale": "en", "object": "redirect_rule", "targetId": "1234567", "targetType": "article", "updatedAt": "2026-02-11T12:00:00.000Z" } ], "nextCursor": null, "object": "list" } ``` ## Create a redirect rule **post** `/v2/help_center/redirect_rules` Creates a new redirect rule in your organization. The `fromUrl` is normalized on creation: query parameters and hash fragments are stripped, the hostname is lowercased, and trailing slashes are removed. The `fromUrl` hostname must match the Help Center's configured custom domain. The target article or collection must exist and have a resolvable URL (i.e., a published translation with a slug). ### Request Body Required attributes: - `helpCenterId` - The ID of the help center this rule belongs to - `locale` - Locale code used to resolve the target translation - `fromUrl` - The full absolute URL to redirect from (must match the help center's custom domain) - `targetType` - "article" or "collection" - `targetId` - The ID of the target article or collection ### Response Returns the created redirect rule object. ### Errors - `400` - Invalid request data, fromUrl does not match custom domain, or target not found ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `fromUrl: string` Full absolute URL to redirect from. Must use http or https protocol. Query parameters and hash fragments are stripped during normalization. The hostname must match the Help Center custom domain. - `helpCenterId: string` Help center identifier this redirect rule belongs to - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale code for the redirect rule. Used to resolve the target article/collection translation. - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `targetId: string` ID of the target article or collection - `targetType: "article" or "collection"` Type of content the redirect points to - `"article"` - `"collection"` ### Returns - `RedirectRule object { id, createdAt, fromUrl, 6 more }` - `id: string` Redirect rule unique identifier - `createdAt: string` ISO 8601 timestamp when created - `fromUrl: string` Canonical source URL being redirected from (query and hash stripped) - `helpCenterId: string` Help center identifier - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale code for the redirect rule - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "redirect_rule"` Object type identifier - `"redirect_rule"` - `targetId: string` Target article or collection ID - `targetType: "article" or "collection"` Type of content the redirect points to - `"article"` - `"collection"` - `updatedAt: string` ISO 8601 timestamp when last updated ### Example ```http curl https://do.featurebase.app/v2/help_center/redirect_rules \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "fromUrl": "https://help.example.com/en/old/getting-started", "helpCenterId": "ox6qrqprmsuqaunj", "locale": "en", "targetId": "10021362", "targetType": "article" }' ``` #### Response ```json { "id": "507f1f77bcf86cd799439011", "createdAt": "2026-02-11T12:00:00.000Z", "fromUrl": "https://help.example.com/en/old/getting-started", "helpCenterId": "ox6qrqprmsuqaunj", "locale": "en", "object": "redirect_rule", "targetId": "1234567", "targetType": "article", "updatedAt": "2026-02-11T12:00:00.000Z" } ``` ## Get a redirect rule by URL **get** `/v2/help_center/redirect_rules/by-url` Retrieves a specific redirect rule by its source URL. The `url` query parameter is normalized before matching: query parameters and hash fragments are stripped, the hostname is lowercased, and trailing slashes are removed. This is the same normalization applied when creating a redirect rule. ### Query Parameters - `url` (required) - Full absolute URL to look up (http or https) ### Response Returns a redirect rule object with: - `id` - Unique identifier (MongoDB ObjectId) - `helpCenterId` - Help center this rule belongs to - `locale` - Locale code - `fromUrl` - Canonical source URL being redirected from - `targetType` - "article" or "collection" - `targetId` - ID of the target article or collection - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Errors - `400` - Invalid URL format - `404` - No redirect rule exists for the given URL ### Query Parameters - `url: string` Full absolute URL to look up. The URL is normalized before matching: query parameters and hash fragments are stripped, the hostname is lowercased, and trailing slashes are removed. ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `RedirectRule object { id, createdAt, fromUrl, 6 more }` - `id: string` Redirect rule unique identifier - `createdAt: string` ISO 8601 timestamp when created - `fromUrl: string` Canonical source URL being redirected from (query and hash stripped) - `helpCenterId: string` Help center identifier - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale code for the redirect rule - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "redirect_rule"` Object type identifier - `"redirect_rule"` - `targetId: string` Target article or collection ID - `targetType: "article" or "collection"` Type of content the redirect points to - `"article"` - `"collection"` - `updatedAt: string` ISO 8601 timestamp when last updated ### Example ```http curl https://do.featurebase.app/v2/help_center/redirect_rules/by-url \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "id": "507f1f77bcf86cd799439011", "createdAt": "2026-02-11T12:00:00.000Z", "fromUrl": "https://help.example.com/en/old/getting-started", "helpCenterId": "ox6qrqprmsuqaunj", "locale": "en", "object": "redirect_rule", "targetId": "1234567", "targetType": "article", "updatedAt": "2026-02-11T12:00:00.000Z" } ``` ## Get a redirect rule by ID **get** `/v2/help_center/redirect_rules/{id}` Retrieves a specific redirect rule by its unique identifier. Returns the redirect rule object if found in your organization. ### Response Returns a redirect rule object with: - `id` - Unique identifier (MongoDB ObjectId) - `helpCenterId` - Help center this rule belongs to - `locale` - Locale code - `fromUrl` - Canonical source URL being redirected from - `targetType` - "article" or "collection" - `targetId` - ID of the target article or collection - `createdAt` - ISO 8601 timestamp when created - `updatedAt` - ISO 8601 timestamp when last updated ### Errors - `404` - Redirect rule not found in your organization ### Path Parameters - `id: string` Redirect rule unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `RedirectRule object { id, createdAt, fromUrl, 6 more }` - `id: string` Redirect rule unique identifier - `createdAt: string` ISO 8601 timestamp when created - `fromUrl: string` Canonical source URL being redirected from (query and hash stripped) - `helpCenterId: string` Help center identifier - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale code for the redirect rule - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "redirect_rule"` Object type identifier - `"redirect_rule"` - `targetId: string` Target article or collection ID - `targetType: "article" or "collection"` Type of content the redirect points to - `"article"` - `"collection"` - `updatedAt: string` ISO 8601 timestamp when last updated ### Example ```http curl https://do.featurebase.app/v2/help_center/redirect_rules/$ID \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "id": "507f1f77bcf86cd799439011", "createdAt": "2026-02-11T12:00:00.000Z", "fromUrl": "https://help.example.com/en/old/getting-started", "helpCenterId": "ox6qrqprmsuqaunj", "locale": "en", "object": "redirect_rule", "targetId": "1234567", "targetType": "article", "updatedAt": "2026-02-11T12:00:00.000Z" } ``` ## Update a redirect rule **patch** `/v2/help_center/redirect_rules/{id}` Updates an existing redirect rule. Only include the fields you wish to update. If `fromUrl` is provided, it will be re-normalized and validated against the Help Center's custom domain. If `targetType` or `targetId` is changed, the new target must exist and have a resolvable URL. ### Path Parameters - `id` - The unique identifier of the redirect rule to update ### Request Body All fields are optional. Only provided fields will be updated: - `helpCenterId` - The help center ID - `locale` - Locale code - `fromUrl` - Updated source URL (will be re-normalized) - `targetType` - "article" or "collection" - `targetId` - ID of the new target article or collection ### Response Returns the updated redirect rule object. ### Errors - `404` - Redirect rule not found - `400` - Invalid data, domain mismatch, duplicate fromUrl, or target not found ### Path Parameters - `id: string` Redirect rule unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Body Parameters - `fromUrl: optional string` Full absolute URL to redirect from. Must use http or https protocol. Query parameters and hash fragments are stripped during normalization. The hostname must match the Help Center custom domain. - `helpCenterId: optional string` Help center identifier - `locale: optional "bn" or "bs" or "pt-BR" or 39 more` Locale code for the redirect rule - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `targetId: optional string` ID of the target article or collection - `targetType: optional "article" or "collection"` Type of content the redirect points to - `"article"` - `"collection"` ### Returns - `RedirectRule object { id, createdAt, fromUrl, 6 more }` - `id: string` Redirect rule unique identifier - `createdAt: string` ISO 8601 timestamp when created - `fromUrl: string` Canonical source URL being redirected from (query and hash stripped) - `helpCenterId: string` Help center identifier - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale code for the redirect rule - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "redirect_rule"` Object type identifier - `"redirect_rule"` - `targetId: string` Target article or collection ID - `targetType: "article" or "collection"` Type of content the redirect points to - `"article"` - `"collection"` - `updatedAt: string` ISO 8601 timestamp when last updated ### Example ```http curl https://do.featurebase.app/v2/help_center/redirect_rules/$ID \ -X PATCH \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" \ -d '{ "fromUrl": "https://help.example.com/en/old/getting-started", "helpCenterId": "ox6qrqprmsuqaunj", "locale": "en", "targetId": "10021362", "targetType": "article" }' ``` #### Response ```json { "id": "507f1f77bcf86cd799439011", "createdAt": "2026-02-11T12:00:00.000Z", "fromUrl": "https://help.example.com/en/old/getting-started", "helpCenterId": "ox6qrqprmsuqaunj", "locale": "en", "object": "redirect_rule", "targetId": "1234567", "targetType": "article", "updatedAt": "2026-02-11T12:00:00.000Z" } ``` ## Delete a redirect rule **delete** `/v2/help_center/redirect_rules/{id}` Deletes an existing redirect rule. The associated Redis cache entry is also invalidated. ### Path Parameters - `id` - The unique identifier of the redirect rule to delete ### Response Returns a deletion confirmation object: - `id` - The ID of the deleted redirect rule - `object` - Always "redirect_rule" - `deleted` - Always true ### Errors - `404` - Redirect rule not found in your organization ### Path Parameters - `id: string` Redirect rule unique identifier ### Header Parameters - `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"` - `"2026-01-01.nova"` - `"2025-12-12.clover"` ### Returns - `id: string` Unique identifier of the deleted redirect rule - `deleted: true` Indicates the resource was deleted - `true` - `object: "redirect_rule"` Object type identifier - `"redirect_rule"` ### Example ```http curl https://do.featurebase.app/v2/help_center/redirect_rules/$ID \ -X DELETE \ -H "Authorization: Bearer $FEATUREBASE_API_KEY" ``` #### Response ```json { "id": "507f1f77bcf86cd799439011", "deleted": true, "object": "redirect_rule" } ``` ## Domain Types ### Redirect Rule - `RedirectRule object { id, createdAt, fromUrl, 6 more }` - `id: string` Redirect rule unique identifier - `createdAt: string` ISO 8601 timestamp when created - `fromUrl: string` Canonical source URL being redirected from (query and hash stripped) - `helpCenterId: string` Help center identifier - `locale: "bn" or "bs" or "pt-BR" or 39 more` Locale code for the redirect rule - `"bn"` - `"bs"` - `"pt-BR"` - `"bg"` - `"ca"` - `"hr"` - `"cs"` - `"da"` - `"nl"` - `"en"` - `"et"` - `"fi"` - `"fr"` - `"de"` - `"el"` - `"hi"` - `"hu"` - `"id"` - `"it"` - `"ja"` - `"ko"` - `"lv"` - `"lt"` - `"ms"` - `"mn"` - `"nb"` - `"pl"` - `"pt"` - `"ro"` - `"ru"` - `"sr"` - `"zh-CN"` - `"sk"` - `"sl"` - `"es"` - `"sw"` - `"sv"` - `"th"` - `"zh-TW"` - `"tr"` - `"uk"` - `"vi"` - `object: "redirect_rule"` Object type identifier - `"redirect_rule"` - `targetId: string` Target article or collection ID - `targetType: "article" or "collection"` Type of content the redirect points to - `"article"` - `"collection"` - `updatedAt: string` ISO 8601 timestamp when last updated ### Redirect Rule Delete Response - `RedirectRuleDeleteResponse object { id, deleted, object }` - `id: string` Unique identifier of the deleted redirect rule - `deleted: true` Indicates the resource was deleted - `true` - `object: "redirect_rule"` Object type identifier - `"redirect_rule"`