Request

Response

    Queries

    topFolders

    GraphQL: Query

    Retrieves all top-level folders within a specified project.

    Template for Query:

    query GetTopFolders($projectId: ID!) {
      topFolders(projectId: $projectId) {
        # TopFolders Fields
      }
    }
    

    Template for Query Variables:

    {
      "projectId" : "<SOME-ID-TYPE-SCALAR-VALUE>"
    }
    


    Arguments

    projectId*
    ID! non-null
    The ID of the project that contains the folders.
    * Required

    Possible Returns

    Value TypeDescription
    Folders! non-null Contains a list of folders returned in response to a query.


    Examples

    Example 1

    Retrieves top folders in a project by ID.

    Query:

    query GetTopFolders($projectId: ID!) {
      topFolders(projectId: $projectId) {
          results {
              id
              name
              objectCount
          }
        }
     }
    
    Show More

    Query Variables:

    {
      "projectId": "cHJvan5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZg"
    }
    

    Response:

    {
      "data": {
          "topFolders": {
              "results": [
                  {
                      "id": "Zm9sZH5iLjc2OGNhZTE0LTc2YjMtNDUzMS05MDMwLTI1MjEyZGFiNGU0OH5iLjIyYTVkYzQ3LWNhMTktNDIzMS05ZjNlLTE1N2ViZDQ4NDJmZn51cm46YWRzay53aXBwcm9kOmZzLmZvbGRlcjpjby40U0F5Z29SSFNjZUllVUlySVMtSUxB",
                      "name": "Project Files",
                      "objectCount": 7
                  }
              ]
          }
       }
     }
    
    Show More