Search folders

post

https://api.safetyculture.io/directory/v1/folders/search

Body Params

The parameters for SearchFoldersRequest

query

string

Optional. The search value to query folders with when provided. When not provided, either all of the organisations folders or users folders will be returned in a paginated way

order_by

object

FoldersOrderBy represents the sort order folders will be returned in

filters

array of objects

Optional. Filters to apply when getting folders. Used for only returning folders that match the filter setting. i.e. only returning meta_label 'location'. Maximum of 1000 filters allowed.

filters

only_assigned_folders

boolean

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

only_leaf_nodes

boolean

When true, SearchFolders will only search location folders. Defaults to false.

include_members_count

boolean

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

include_folders_count

boolean

Whether to return the total number of folders discovered in the query. Defaults to false

include_deleted_folders

boolean

Whether to return both deleted and non-deleted folders. Defaults to false

limit

int32

The number of results to be returned. maximum 1500, default 500

page_token

string

The offset used for pagination. The starting number for the next query

ignore_folders_disabled

boolean

Optional. When true, folders will still be returned when disabled for the organisation

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

Responses

Language

Credentials

Bearer

Loading…

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.