API
Start typing to search…

List folders

get
https://api.safetyculture.io/directory/v1/folders
Query Params
int32

Required. This determines the max number of folders returned in the response.

string

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

string
enum
Defaults to SORT_FIELD_UNSPECIFIED

The field to order by

  • SORT_FIELD_UNSPECIFIED: The sort field is unspecified
  • SORT_FIELD_NAME: Sort the folder by name
  • SORT_FIELD_FOLDER_ID: Sort the folders by folder id
  • SORT_FIELD_USER_ID: Sort the folders by user id
  • SORT_FIELD_CREATED_AT: Sort the folders by created at
  • SORT_FIELD_MODIFIED_AT: Sort the folders by modified at
Allowed:
string
enum
Defaults to SORT_ORDER_UNSPECIFIED

The direction to order by

  • SORT_ORDER_UNSPECIFIED: The sort order is not specified
  • SORT_ORDER_ASCENDING: The sort order is asc
  • SORT_ORDER_DESCENDING: The sort order is desc
Allowed:
boolean

Optional. When true, GetFolders will only return leaf node folders. leaf nodes are folders that do not have children Defaults to false.

boolean

Optional. When true, folders will be returned with a list of their ancestors as well. Defaults to false

boolean

When true, deleted folders will also be returned

boolean

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

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

Updated 5 months ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago