v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB

Directory (Sites)

Get folders (by parent)

get/directory/v1/parent/{id}/folders

Path parameters

idstring required

Optional. The identifier of the parent folder. When no parent folder ID is given all top level root folders will be returned

Query parameters

include_members_countboolean

Optional. Whether to return the directly associated members count with the folders. Defaults to false.

limitinteger

The number of results to be returned.

page_tokenstring

Optional. base64 encoded. If this field is present, the list of folders returned will start from the row after this token.

include_inherited_members_countboolean

Optional. Whether to include the number of inherited members for each folder

domainstring

domain represents the type/domain/hierarchy for the folder. This is used for getting folders of a certain domain, i.e. getting all template folders or site folders

only_assigned_foldersboolean

When true, GetFoldersByParent will only return folders that are assigned to the user making the request. Defaults to false

with_deleted_foldersboolean

Optional. When true, deleted and non-deleted folders will be returned.

Response

A successful response.

next_page_tokenstring

Optional. base64 encoded. If this field is present, the value should be used in subsequent calls to GetFoldersByParent to get the next page of results. Otherwise, no further calls should be made.

Example response

{
  "folders": [
    {
      "folder": {
        "id": "4fb56fa8-fa23-4a9c-907e-8367abc75a2f",
        "name": "Sydney",
        "org_id": "d31e24be-e7a4-4a28-a230-044f850041fc",
        "creator_id": "a3452937-9fa7-4ba2-9ffa-c3bbee3fc947",
        "created_at": "2020-04-28T04:14:31:00Z",
        "modified_at": "2020-04-28T04:14:31:00Z",
        "meta_label": "location"
      }
    }
  ]
}