organisation
Returns a single Organisation by ID. The Organisation is the top-level entity containing groups, users, billing, and data management.
Arguments
| Argument | Type | Required | Description |
|---|---|---|---|
id | ID | No | Global node ID |
orgId | ID | No | Organisation-specific ID |
Provide either id or orgId.
Return Type
Example
query GetOrganisation($orgId: ID) {
organisation(id: $orgId) {
id
name
ipAddress
retention
pdfRetention
userCount
created
billing {
planName
paymentSystem
currency
docSendCredit
userLimit
cancelledAt
}
quotas {
docSendCredit
bulkSendCredit
}
groupConnection {
edges {
node {
id
name
}
}
totalCount
}
}
}
Real-world: Fetch billing with invoices
From the Legalesign Console app:
query GetBilling($orgId: ID) {
organisation(id: $orgId) {
billing {
customerName
address1
address2
postcode
billingContactEmail
billingContactEmailCc
technicalContactEmail
taxRate
docSendCredit
userCount
userLimit
alertCount
libraryLimit
groupLimit
planName
paymentSystem
currency
cancelledAt
invoiceConnection {
invoices {
id
created
invoiceNumber
subTotal
totalIncTax
currency
}
}
}
}
}