Skip to main content

Retention

A Retention record tracks the scheduled deletion time for a data record or file. Retention records are managed at the Organisation level and show when data will be automatically deleted.

Implements: Node

Fields

FieldTypeDescription
idID!Unique identifier
organisationID!Organisation ID
groupIDGroup ID (if applicable)
locationStringResource location (database, cloud storage, or system record)
ttlAWSDateTimeTime to live (scheduled deletion date)
completedAWSDateTimeWhen the resource was actually deleted

Query

Retention records are accessed via Organisation.retentionConnection:

query GetRetentionRecords($orgId: ID) {
organisation(id: $orgId) {
retentionConnection(
start: "2025-01-01T00:00:00Z"
end: "2025-12-31T23:59:59Z"
first: 100
) {
retentions {
id
location
ttl
completed
group
}
totalCount
}
}
}
  • Organisation — retention is managed at the organisation level
  • Group — groups have their own retention period settings

Export This Article

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