formAnswerGroups

All filled forms for a given set of arguments

Arguments

custom_module_form_id · ID · Filter by form template ID.

date · ISO8601DateTime · Filter to only show results created on a specific date. Supersedes `start_date` and `end_date` (which show results after or before a certain date).

end_date · ISO8601Date · When passed in, only filled forms created before the specified datetime are returned.

filler_id · ID · Filter by the ID of the individual who filled out the items.

form_answer_group_id · ID · Filter by form answer group ID.

ids · [ID] · Accepts an array of FormAnswerGroup IDs.

include_group_notes · Boolean · When true, includes group notes (form answer groups tied to a group appointment). When false or not passed in, group notes are excluded.

name · String · Filter by name of the form answer group or associated form template.

user_id · ID · The ID of the client whose form answer groups to retrieve.

locked_status · Boolean · When true, returns only locked form answer groups. When false, returns only unlocked form answer groups. When not passed in, returns both locked and unlocked form answer groups.

signed_status · Boolean · When true, returns only signed form answer groups. When false, returns only unsigned form answer groups. When not passed in, returns both signed and unsigned form answer groups.

start_date · ISO8601Date · When passed in, only filled forms created after the specified datetime are returned.

updated_after · ISO8601DateTime · When passed in, only objects updated after the specified datetime are returned.

updated_before · ISO8601DateTime · When passed in, only objects updated before the specified datetime are returned.

order_by · FormAnswerGroupOrderKeys · The order to return the form answer groups in.

use_for_charting · Boolean · When true, only returns form answer groups for forms marked for charting use.

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

FormAnswerGroupPaginationConnection

Example

query formAnswerGroups(
  $custom_module_form_id: ID
  $date: ISO8601DateTime
  $end_date: ISO8601Date
  $filler_id: ID
  $form_answer_group_id: ID
  $ids: [ID]
  $include_group_notes: Boolean
  $name: String
  $user_id: ID
  $locked_status: Boolean
  $signed_status: Boolean
  $start_date: ISO8601Date
  $updated_after: ISO8601DateTime
  $updated_before: ISO8601DateTime
  $order_by: FormAnswerGroupOrderKeys
  $use_for_charting: Boolean
  $after: String
  $before: String
  $first: Int
  $last: Int
) {
  formAnswerGroups(
    custom_module_form_id: $custom_module_form_id
    date: $date
    end_date: $end_date
    filler_id: $filler_id
    form_answer_group_id: $form_answer_group_id
    ids: $ids
    include_group_notes: $include_group_notes
    name: $name
    user_id: $user_id
    locked_status: $locked_status
    signed_status: $signed_status
    start_date: $start_date
    updated_after: $updated_after
    updated_before: $updated_before
    order_by: $order_by
    use_for_charting: $use_for_charting
    after: $after
    before: $before
    first: $first
    last: $last
  ) {
    edges
    nodes
    page_info
    total_count
  }
}