Space manuals

The purpose of this API is to get the list of manuals in a space.

Request URL:https://learn.zoho.com/learn/api/v1/hubs/<hubUrl>/spaces/<spaceUrl>/manuals
OAuth Scope:ZohoLearn.manual.READ
Request Method:GET
ParameterDescriptionRequired
pageIndex

The starting index of the page.

  • The input parameter type is Integer.
  • The default value is 0.
Optional
limit

The number of items to be fetched.

  • The input parameter type is Integer.
  • The default value is 20.
 
sortBy

recent/alpha

recent - to get the list of manuals in order of most recent.

alpha - to get the list of manuals in the alphabetical order.

  • The input parameter type is String.
  • The default value is recent.
 
isAsc

true/false

true - to get the list of manuals in the ascending order.

false - to get the list of manuals in the descending order.

  • The input parameter type is Boolean.
  • The default value is false.
 

Success response

Copied{
    "manuals": [
        {
            "id": "556677",
            "name": "Manual 1",
            "url": "manual-1",
            "createdBy": "998877",
            "createdTime": "1752498384123"
        },
        {
            "id": "556688",
            "name": "Manual 2",
            "url": "manual-2",
            "createdBy": "998877",
            "createdTime": "1751603039848"
        },
        {
            "id": "556699",
            "name": "Manual 3",
            "url": "manual-3",
            "createdBy": "998866",
            "createdTime": "1751559595922"
        }
    ],
    "fetchMore": "true"
}

Failure response

Copied{
    "result":"failure",
    "reason":"Exception while getting manual list"
}