documents

Fetch paginated documents collection

Arguments

consolidated_user_id · String · The ID of a patient or client whose documents a provider wants to view.

file_type · String · Filters documents by file type (e.g. "all", "other").

file_types · [String] · (DEPRECATED)

filter · String · Filters documents by sharing status. Accepted values: "all", "shared", "private".

folder_id · String · The ID of the folder to fetch documents from.

for_template_use · Boolean · When true, returns only provider-level documents with no associated patient or client, for use in templates.

keywords · String · Search term to filter documents by name.

private_user_id · String · The ID of the user whose private documents to fetch.

provider_id · ID · The ID of the provider whose documents to fetch. Defaults to the current user.

viewable_user_id · String · The ID of a viewable user whose documents to fetch.

sort_by · String · Deprecated.

order_by · DocumentOrderKeys · Sort order key for the returned documents.

after · String · Returns the elements in the list that come after the specified cursor.

before · String · Returns the elements in the list that come before the specified cursor.

first · Int · Returns the first _n_ elements from the list.

last · Int · Returns the last _n_ elements from the list.

Returns

DocumentPaginationConnection

Example

query documents(
  $consolidated_user_id: String
  $file_type: String
  $file_types: [String]
  $filter: String
  $folder_id: String
  $for_template_use: Boolean
  $keywords: String
  $private_user_id: String
  $provider_id: ID
  $viewable_user_id: String
  $sort_by: String
  $order_by: DocumentOrderKeys
  $after: String
  $before: String
  $first: Int
  $last: Int
) {
  documents(
    consolidated_user_id: $consolidated_user_id
    file_type: $file_type
    file_types: $file_types
    filter: $filter
    folder_id: $folder_id
    for_template_use: $for_template_use
    keywords: $keywords
    private_user_id: $private_user_id
    provider_id: $provider_id
    viewable_user_id: $viewable_user_id
    sort_by: $sort_by
    order_by: $order_by
    after: $after
    before: $before
    first: $first
    last: $last
  ) {
    edges
    nodes
    page_info
    total_count
  }
}