DocumentElement

A DocumentElement is a field on a sent Document. It mirrors the structure of a TemplateElement but includes the actual values completed by signers or senders.

DocumentElements are accessed via Document.elementConnection (sender fields) or Recipient.elementConnection (signer fields).

Fields

Field	Type	Description
id	ID!	Unique identifier
elementType	String!	Field type (e.g. SIGNATURE, TEXT)
page	Int	Page number
ax	Float	Start X coordinate
ay	Float	Start Y coordinate
bx	Float	End X coordinate
by	Float	End Y coordinate
align	String	Text alignment
label	String	Field label
labelExtra	String	Additional label text
helpText	String	Help text
value	String	Completed value
optional	Boolean	Whether the field is optional
substantive	Boolean	Whether the field is substantive
validation	Int	Validation rule ID
options	String	Options for dropdowns/radio buttons
signer	Int	Signer index
role	String	Role name
fontName	String	Font name
fontSize	Int	Font size
hideBorder	Boolean	Hide border
fieldOrder	Int	Tab order
logicGroup	String	Logic group
logicAction	Int	Logic action
mapTo	String	Map-to identifier
excludeFromPdf	Boolean	Exclude this field's value from the final PDF
link	String	Short-lease URL if the element is a file download

Query

query GetDocumentFields {
  document(id: "ZG9jMWVmMjdkYWYtMGJlMS0xMWYwLWJiYjUtMDZlNDc2YTA3NTY5") {
    elementConnection {
      documentElements {
        id
        elementType
        label
        value
        page
      }
    }
    recipients {
      id
      firstName
      lastName
      elementConnection {
        documentElements {
          id
          elementType
          label
          value
        }
      }
    }
  }
}

Related

• Document — the document these elements belong to
• TemplateElement — the template-level equivalent
• Recipient — recipients have their own element connections