Organisation

An Organisation is a company, charity, or other corporate entity. Organisations contain Groups for departmental teams and manage billing, user permissions, and data retention at the top level.

Implements: Node

Fields

Field	Type	Description
id	ID!	Unique identifier
name	String!	Full title of the organisation
ipAddress	String	IP security restrictions for users
retention	Int	Default data retention period (days)
pdfRetention	Int	Default PDF retention (days)
attachmentRetention	Int	Default attachment retention (days)
textRetention	Int	Default text file retention (days)
created	AWSDateTime	When the organisation was created
userCount	Int	Count of users in this organisation

Relationships

Field	Type	Description
billing	Billing	Billing information (requires billing permission)
quotas	Quotas	Send credits and contact information

Connections

All connections support cursor-based pagination.

groupConnection

Groups belonging to this organisation.

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

userConnection

Users and their organisation-level permissions.

Argument	Type	Description
first	Int	Number of items
after	ID	Pagination cursor
userId	ID	Filter to a specific user

retentionConnection

Data retention records showing when data and documents will be deleted.

Argument	Type	Description
first	Int	Number of items
after	ID	Pagination cursor
start	AWSDateTime	Filter by start date
end	AWSDateTime	Filter by end date
filter	String	Filter by retention compound key

dataStopConnection, dataDeletionConnection, invoiceConnection

Standard pagination arguments (first, after, last, before).

dataSubjectConnection

Search for documents associated with a specific email address.

Argument	Type	Description
email	AWSEmail!	Email address to search
first	Int	Number of items
after	ID	Pagination cursor

Query

query GetOrganisation($id: ID!) {
  organisation(id: $id) {
    id
    name
    userCount
    retention
  }
}

Example

Loading organisation data with user permissions (based on the Legalesign Console app):

query GetMyOrganisations {
  user {
    organisationConnection {
      organisations {
        id
        created
      }
      edges {
        node {
          id
          name
        }
        canInvoice
        canMakeTeams
        canReleaseData
        canChangeTeams
        canAccessBilling
        canExportRecords
        canStopProcessing
        canAdministerUsers
        canChangeRetention
      }
    }
  }
}

note

Organisation-level permissions are returned on the OrganisationEdge, not on the Organisation itself. This includes fields like canAdministerUsers, canAccessBilling, and canMakeTeams.

Related

• Group — groups within this organisation
• User — users in this organisation
• Billing — billing and subscription details
• Query Examples — basic organisation query
• Complex Query Examples — organisation with nested data
• Mutation Examples — organisation mutations