OBJECT

Folder

A folder that contains documents and other folders

link GraphQL Schema definition

  • type Folder {
  • # When true, the user cannot adjust settings for the folder besides sharing.
  • can_only_share: Boolean
  • # The date the folder was made available to the given user
  • #
  • # Arguments
  • # viewable_user_id: Select by a specific user
  • created_at(viewable_user_id: String): String!
  • # If true, the current user can edit the folder
  • current_user_can_edit: Boolean
  • # The description of the folder
  • description: String
  • # The number of documents within this folder
  • documents_count: Int
  • # Include the file in new clients welcome email
  • email_on_welcome: Boolean!
  • # The ID of the parent folder
  • folder_id: String
  • # The list of parent folders for this folder
  • #
  • # Arguments
  • # client_id: Select by a specific client
  • folder_path(client_id: String): [Folder!]
  • # The unique identifier of the folder
  • id: ID!
  • # The name of the folder
  • name: String
  • # Owner of this folder
  • owner: User
  • # The parent folder of this folder (nil if there is no parent)
  • parent_folder: Folder
  • # In the case of a private folder, the user that this folder is for
  • rel_user: User
  • # The ID of the connected user
  • rel_user_id: String
  • # The folder shared
  • shared: Boolean
  • # Share the file with new clients automatically
  • shared_on_welcome: Boolean!
  • # The number of user groups who the folder is shared
  • shared_user_groups_count: Int
  • # The number of users who the folder is directly shared with (not through groups)
  • shared_users_count: Int
  • # Share with all members of the organization
  • shared_with_dietitians: Boolean!
  • # The number of subfolders within this folder
  • subfolders_count: Int
  • # The folder has a reserved name generated by the system
  • system_generated: Boolean!
  • # The user groups who have access to this folder
  • user_groups: [UserGroup!]!
  • # The users who have access to this folder
  • users: [User!]!
  • }