Group

A Group (sometimes called a team) is a workspace within an Organisation. Groups contain templates, documents, contacts, and their own settings for data retention, PDF security, and signing experiences. Users access groups through GroupMember records which define their permissions.

Implements: Node

Fields

Field	Type	Description
id	ID!	Unique identifier
name	String!	Group title
publicName	String	Public-facing name for external use
attachmentRetention	Int!	Retention period for attachments (days)
pdfRetention	Int!	Retention period for PDFs (days)
retention	Int!	Retention period for other data (days)
textRetention	Int!	Retention period for text files (days)
apiIntegration	Boolean	Whether this group is for API integration
style	AWSJSON	Custom styling for this group
certifyDocuments	Boolean	Certify final documents
sequentialSend	Boolean	Default sending sequence for multiple documents
stopPDFPrinting	Boolean	Prevent printing of final PDF
stopPDFCopying	Boolean	Prevent copying of final PDF
appendAuditLog	Boolean	Append audit log to signed PDF
autoTag	Boolean	Append Legalesign and signer info to PDF
appendAdditionalSignerInfo	Boolean	Check for text tags on upload
passwordType	Int	PDF password protection (0=none, 1=kept, 2=deleted after signing)
pdfPassword	String	Password for the final PDF
retainPdfPassword	Boolean	Retain password after signing
licensesRemaining	Int	Remaining send licenses
credit	Int	Send credits for this group
owner	ID	User ID of the group owner
groupCCEmail	[AWSEmail]	CC email for all final documents
emailDomainSettings	AWSJSON	Domain-specific email format settings
emailSubjectToSenderIfCompleted	String	Email subject when document completed
emailSubjectToSenderIfRejected	String	Email subject when document rejected
sendWhenSignedOrRejected	Boolean	Notify sender on sign/reject
attachPDFWhenNotifying	Boolean	Attach PDF to notification emails
sendWhenBounces	Boolean	Notify sender on email bounce

Relationships

Field	Type	Description
organisation	Organisation	Parent organisation
cloudStore	CloudStore	Active cloud storage connection
settings	[GroupSetting]	Advanced extensible settings

Connections

All connections support cursor-based pagination.

memberConnection

Members of this group with their permissions.

Argument	Type	Description
first	Int	Number of items
after	ID	Pagination cursor

documentConnection

Documents sent from this group.

Argument	Type	Default	Description
first	Int	—	Number of items
after	ID	—	Pagination cursor
from	AWSDateTime	—	Start date filter
to	AWSDateTime	—	End date filter
search	String	null	Search by name
status	String	null	Filter by status
sendType	SendType	ALL	SINGLE, BATCHED, or ALL
sender	[ID]	null	Filter by sender user IDs

templateConnection

Templates in this group.

Argument	Type	Default	Description
first	Int	—	Number of items
after	ID	—	Pagination cursor
archived	Boolean	false	Include archived
search	String	null	Search by title
status	String	null	Filter by status

batchConnection

Batches sent from this group.

Argument	Type	Default	Description
first	Int	—	Number of items
after	ID	—	Pagination cursor
from	AWSDateTime	—	Start date filter
to	AWSDateTime	—	End date filter
search	String	null	Search by name
status	String	null	Filter by status
archived	Boolean	false	Filter archived
type	BatchType	—	BULK or BATCH

experienceConnection, scheduleConnection, attachmentConnection, contactConnection, contactGroupConnection, draftConnection, invitationConnection, standardMessageConnection

Standard pagination arguments (first, after, last, before). contactConnection also accepts a filter argument (AWSJSON) for field-level filtering. draftConnection accepts a search argument.

activityConnection

Recent activity for this group (last 90 days). No pagination arguments.

reportData

Argument	Type	Description
start	AWSDateTime!	Report period start
end	AWSDateTime!	Report period end
reportType	ReportType	Default SIGNINGTIME

Query

query GetGroup($id: ID!) {
  group(id: $id) {
    id
    name
    publicName
    credit
    licensesRemaining
  }
}

Example

Loading group settings and options in a single call (based on the Legalesign Console app):

query GetGroupOptions {
  group(id: "Z3JwbGVnYWxlc2lnbxRldg==") {
    id
    retention
    certifyDocuments
    stopPDFPrinting
    stopPDFCopying
    appendAuditLog
    pdfPassword
    retainPdfPassword
    settings {
      name
      value
    }
    templateConnection {
      templates {
        id
        title
        valid
        locked
        pageCount
      }
      totalCount
    }
    experienceConnection {
      experiences {
        id
        name
        defaultExperience
        language
      }
    }
    scheduleConnection {
      schedules {
        id
        name
        default
        items {
          id
          daysAfter
          frequency
          subject
          when
          timeOfDay
          skipWeekend
        }
      }
    }
  }
}

Related

• Organisation — parent organisation
• Document — documents in this group
• Template — templates in this group
• How Pagination Works — paginating group connections
• Query Examples — basic group query
• Complex Query Examples — group with nested data
• Mutation Examples — create and update groups