API - "Get Workspace folders" Method Results Not Matching Documentation

I'm making the call with the parameters matching the documentation and not getting the same results. I'm only getting "id", "name" and "permalink" for each folder. The "Responses" in the documentation includes an array with reports, sheets, sights and templates, as well as details for each of those objects.

Am I doing something incorrectly in my call, or is the documentation inaccurate?

If the documentation is inaccurate, is there a method available to accomplish the output in the documentation without looping through each folder?

Periods added below to format indenting, in the hope that it's easier to read. Didn't have success with the code format option.

Input

{
…"uri": "https://api.smartsheet.com/2.0/workspaces/7229146649651076/folders",
…"method": "GET",
…"queries": {
……"accessApiLevel": "0",
……"includeAll": "true"
…},
…"headers": {
……"Authorization": "sanitized",
……"Content-Type": "application/json"
…}
}

Sample Output with Sensitive Data Redacted

{
…"statusCode": 200,

…"headers": {
……"Date": "Wed, 31 Jul 2024 17:24:23 GMT",
……[REDACTED]
……"Content-Length": "3713"
…},
…"body": {
……"pageNumber": 1,
……"totalPages": 1,
……"totalCount": 26,
……"data": [
………{
…………"id": REDACTED,
…………"name": "REDACTED",
…………"permalink": "REDACTED"
………},
………[REDACTED]
………{
…………"id": REDACTED,
…………"name": "REDACTED",
…………"permalink": "REDACTED"
………}
……]
…}
}

Find more posts tagged with

Workspaces

API and Developers

folder

Accepted answers

All comments

adp_cl

I'm experiencing something similar now with the "Get Reports" method. Only returning five fields, versus the large array of data in the documentation.

Ryan Sides

I'm getting the same. That's odd.

jmyzk_cloudsmart_jp

Hi @adp_cl

To retrieve the contents of Sheets, Reports, and Sights within a folder using the Smartsheet API, you need to utilize the Folder ID obtained from the "Get Workspace Folder" method. Once you have the Folder ID, you should call the "Get Folder" method. This process is necessary because the "Get Workspace Folder" method typically provides basic details like "id", "name", and "permalink" for each folder, but does not include detailed information about the contents within those folders. Using the Folder ID with the "Get Folder" method allows you to access more specific details about the sheets, reports, and sights contained within that folder. So, the API document's response example is somewhat misleading.

adp_cl

Thank you, @jmyzk_cloudsmart_jp . I'm familiar with the "Get folder" method and looping through folders.

The documentation is very misleading, unless I'm missing some sort of criteria in my call. I was hopeful that I would be able to use this method instead of looping "Get folder" calls.

Sign in to join the conversation!

Quick Links

Component react.discussion.discussions had an error.

ref must be one of: categoryID, siteSectionID, category, category/categoryID, category/name, category/description, category/url, category/allowedDiscussionTypes, locale, siteSection, siteSection/basePath, siteSection/contentLocale, siteSection/sectionGroup, siteSection/sectionID, siteSection/name, siteSection/description, siteSection/apps, siteSection/attributes, layoutViewType, discussionID, commentID, page, sort, discussion, discussion/name, tags, breadcrumbs, discussionApiParams, serverDraftID, serverDraft.