Request

Response

    Queries

    foldersByProject

    GraphQL: Query

    Retrieves all top level folders under a specified project that meet the filter criteria specified by the filter argument.

    Template for Query:

    query GetFoldersByProject($projectId: ID!, $filter: FolderFilterInput, $pagination: PaginationInput) {
      foldersByProject(projectId: $projectId, filter: $filter, pagination: $pagination) {
        # FoldersByProject Fields
      }
    }
    

    Template for Query Variables:

    {
      "projectId" : "<SOME-ID-TYPE-SCALAR-VALUE>",
      "filter" : "<SOME-FOLDERFILTER-INPUT-TYPE-VALUE>",
      "pagination" : "<SOME-PAGINATION-INPUT-TYPE-VALUE>"
    }
    


    Arguments

    projectId*
    ID! non-null
    The ID of the project that contains the items.
    filterSpecifies how to filter on folders. You can filter by name.
    paginationSpecifies how to split the response into multiple pages.
    * Required

    Possible Returns

    Value TypeDescription
    Folders A list of Folders returned in response to a query. A folder contains items, such as designs and sub-folders.


    Examples