Skip to main content

group

Returns a single Group by ID. A Group is the primary working container — it holds documents, templates, members, experiences, schedules, contacts, and settings.

Arguments

ArgumentTypeRequiredDescription
idIDNoGlobal node ID
groupIdIDNoGroup-specific ID

Provide either id or groupId.

Return Type

Group

Example

query GetGroup($id: ID!) {
group(id: $id) {
id
name
publicName
owner
credit
retention
certifyDocuments
sequentialSend
settings {
name
value
}
templateConnection(first: 100) {
templates {
id
title
valid
locked
}
totalCount
}
memberConnection {
groupMembers {
id
permission
user {
id
email
firstName
lastName
}
}
}
}
}

Real-world: Load all group options for sending

From the Legalesign Console app — fetches templates, experiences, schedules, messages, attachments, and contacts in a single query:

query GetGroupOptions($id: ID!) {
group(id: $id) {
id
retention
certifyDocuments
sendWhenBounces
templateConnection {
templates {
id
title
valid
locked
pageCount
}
totalCount
}
experienceConnection {
experiences {
id
name
language
defaultExperience
}
}
scheduleConnection {
schedules {
id
name
default
items {
id
daysAfter
frequency
subject
message
when
timeOfDay
skipWeekend
}
}
}
standardMessageConnection {
messages {
id
name
default
body
}
}
attachmentConnection {
attachments {
id
filename
autoAttach
description
}
}
contactConnection {
contacts {
id
firstName
lastName
email
phoneNumber
}
}
}
}

Export This Article

Save a copy of this page as PDF or plain text.