OBJECT

Document

A document file that contains an attachment and information about the attachment

link GraphQL Schema definition

  • type Document {
  • # When true, the user cannot adjust settings for the document besides sharing.
  • can_only_share: Boolean
  • # The date the document was made available to the given client
  • #
  • # Arguments
  • # viewable_user_id: The custom ID of viewable user (default:
  • # current user)
  • created_at(viewable_user_id: String): String!
  • # Pagination cursor
  • cursor: Cursor!
  • # The description of the document
  • description: String
  • # The display name of the document
  • display_name: String
  • # Include the file in new clients welcome email
  • email_on_welcome: Boolean!
  • # A URL to download the file, good for 10 seconds
  • expiring_url: String
  • # The extension of the document
  • extension: String
  • # The file type of the document
  • file_content_type: String
  • # The file extension in human-readable format e.g.: 'Video'/'Audio'/'Excel' etc
  • friendly_type: String
  • # The unique idenitifer of the document
  • id: ID!
  • # Include the document within the private charts section
  • include_in_charting: Boolean!
  • # Notes on the document (not visible to the client)
  • internal_notes: String
  • # Instances of the document being viewed/opened
  • opens: [DocumentViewing!]
  • # Owner of this document
  • owner: User
  • # In the case of a private document, the user that this document is for
  • rel_user: User
  • # ID of the assigned client
  • rel_user_id: ID
  • # The document shared
  • shared: Boolean
  • # Share the file with new clients automatically
  • shared_on_welcome: Boolean!
  • # The number of user groups who the document is shared
  • shared_user_groups_count: Int
  • # The number of users who the document is directly shared with (not through
  • # groups)
  • shared_users_count: Int
  • # Share with all members of the organization
  • shared_with_dietitians: Boolean!
  • # The date the document was updated
  • updated_at: String!
  • # The user groups who have access to this document
  • user_groups: [UserGroup!]!
  • # The users who have access to this document
  • users: [User!]!
  • }