List retention classes

curl --request GET \
  --url 'https://app.output.rocks/api/archive/retention-classes' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

{
  "items": [
    {
      "code": "string",
      "name": "Example name",
      "durationYears": 1,
      "startMode": "document-year-end",
      "deletionMode": "automatic",
      "description": "Example description",
      "legalBasis": "string",
      "statutory": true,
      "reconciliationPending": 1,
      "reconciliationUrgent": 1
    }
  ]
}

List retention classes

Three immutable statutory classes plus tenant classes.

GET/api/archive/retention-classes

List retention classes

curl --request GET \
  --url 'https://app.output.rocks/api/archive/retention-classes' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

{
  "items": [
    {
      "code": "string",
      "name": "Example name",
      "durationYears": 1,
      "startMode": "document-year-end",
      "deletionMode": "automatic",
      "description": "Example description",
      "legalBasis": "string",
      "statutory": true,
      "reconciliationPending": 1,
      "reconciliationUrgent": 1
    }
  ]
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

archiveOAuth

oauth2oauth2required

No description provided.

Response

200application/json

Successful response

items

object[]