Get folders (by parent)

get

https://api.safetyculture.io/directory/v1/parent/{id}/folders

Path Params

string

required

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

Query Params

include_members_count

boolean

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

limit

int32

The number of results to be returned.

page_token

string

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

include_inherited_members_count

boolean

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

domain

string

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_folders

boolean

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

with_deleted_folders

boolean

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

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

defaultAn unexpected error response.