The purpose of this API is to get the list of manuals that are shared to a custom portal.
| Request URL: | https://learn.zoho.com/learn/api/v1/portal/<networkurl>/customportal/<customportalId>/manual |
| OAuth Scope: | ZohoLearn.customportal.READ |
| Request Method: | GET |
| Parameter | Description | Required |
| pageIndex | The page number. The default value is 0. | Optional |
| limit | The number of courses to get. Maximum value is 99. Default value is 20. | Optional |
| sortBy | Sort the list using "alpha" for the alphabetical order or "recent" for the last modified order. | Optional |
| isAsc | Boolean value for ascending order. | Optional |
| view |
| Optional |
| categoryIds | Array of category ids to filter courses. | Optional |
| subcategoryIds | Array of sub category ids to filter courses. | Optional |
| tagIds | Array of tag ids to filter courses. | Optional |
| createdByIds |
Sample response
Copied{
"MANUALS": [
{
"clientsCount": "0",
"bannerType": "ZFS",
"description": "Craft compelling narratives and engage your audience like a pro.",
"colorIndex": "5",
"articleCount": "13",
"nameTile": "B",
"type": "MANUAL",
"url": "blogging-guide",
"name": "Blogging Guide",
"createdTime": "18 Jan 2023",
"parentPartitionId": "6342496000000008001",
"id": "6342496000000008027",
"clientEnrollmentType": "PRIVATE",
"createdUser": "799691738",
"status": "UNPUBLISHED",
"clientPortalPartitionOrder": "0"
},
{
"clientsCount": "0",
"bannerType": "SOLID_COLOR",
"description": "Comprehensive guidance for effective policies, procedures, and a harmonious work environment.",
"colorIndex": "2",
"articleCount": "24",
"nameTile": "E",
"type": "MANUAL",
"url": "employee-handbook",
"isBannerUploaded": "true",
"name": "Employee Handbook",
"createdTime": "18 Jan 2023",
"parentPartitionId": "6342496000000009005",
"id": "6342496000000009011",
"clientEnrollmentType": "PRIVATE",
"createdUser": "799691738",
"status": "ACTIVE",
"clientPortalPartitionOrder": "1"
},
{
"clientsCount": "0",
"bannerType": "ZFS",
"description": "Comprehensive guide to crafting impactful and resonant design solutions.",
"colorIndex": "3",
"articleCount": "12",
"nameTile": "D",
"type": "MANUAL",
"url": "design-guide-for-zylker",
"name": "Design Guide",
"createdTime": "16 Aug 2023",
"parentPartitionId": "6342496000000102001",
"id": "6342496000000102007",
"clientEnrollmentType": "PRIVATE",
"createdUser": "799691738",
"status": "ACTIVE",
"clientPortalPartitionOrder": "2"
},
{
"clientsCount": "0",
"bannerType": "ZFS",
"description": "Complete FAQs on billing and payments answered.",
"colorIndex": "1",
"articleCount": "5",
"nameTile": "B",
"type": "MANUAL",
"url": "billing-and-payments-guide",
"name": "Billing and Payments Guide",
"createdTime": "30 May 2023",
"parentPartitionId": "6342496000000071001",
"id": "6342496000000071007",
"clientEnrollmentType": "PRIVATE",
"createdUser": "799691738",
"status": "UNPUBLISHED",
"clientPortalPartitionOrder": "3"
},
{
"isBannerThumbnailUploaded": "true",
"clientsCount": "1",
"bannerType": "ZFS",
"description": "This manual is for Zylker Partners. Contains all information related to on boarding and support.",
"colorIndex": "6",
"articleCount": "16",
"nameTile": "P",
"type": "MANUAL",
"url": "partner-support",
"isBannerUploaded": "true",
"name": "Partner Support",
"createdTime": "05 Feb 2023",
"parentPartitionId": "6342496000000017157",
"id": "6342496000000017163",
"clientEnrollmentType": "PUBLIC",
"isClientPublic": "true",
"createdUser": "799691738",
"status": "ACTIVE",
"clientPortalPartitionOrder": "4"
},
{
"isBannerThumbnailUploaded": "true",
"clientsCount": "2",
"bannerType": "ZFS",
"description": "A comprehensive guide to upholding user privacy and data security in all aspects of our operations.",
"colorIndex": "3",
"articleCount": "11",
"nameTile": "P",
"type": "MANUAL",
"url": "privacy-commitment",
"isBannerUploaded": "true",
"name": "Privacy Commitment",
"createdTime": "05 Feb 2023",
"parentPartitionId": "6342496000000017019",
"id": "6342496000000017025",
"clientEnrollmentType": "PUBLIC",
"isClientPublic": "true",
"createdUser": "799691738",
"status": "ACTIVE",
"clientPortalPartitionOrder": "5"
},
{
"clientsCount": "0",
"bannerType": "ZFS",
"description": "Master the art of automated campaigns and personalized customer experiences.",
"colorIndex": "1",
"articleCount": "21",
"nameTile": "M",
"type": "MANUAL",
"url": "marketing-automation",
"name": "Marketing Automation",
"createdTime": "28 Jan 2023",
"parentPartitionId": "6342496000000008001",
"id": "6342496000000012001",
"clientEnrollmentType": "PUBLIC",
"isClientPublic": "true",
"createdUser": "799691738",
"status": "ACTIVE",
"clientPortalPartitionOrder": "6"
}
],
"STATUS": "OK"
}