Register
API Explorer 43 endpoints
https://k8s.openbankproject.com

Get Retention Archive Entries

GET /obp/v7.0.0/management/banks/BANK_ID/retention-archive

OBPv7.0.0-getRetentionArchiveEntries Roles: CanGetRetentionArchive(per bank) Data-RetentionAPI

The entries of a space's retention archive, newest first, without their content. Optional query parameters, each matching exactly: resource_type, resource_id, entity_name, owner_user_id, retention_policy_id, retention_run_id; and limit (1 to 500, default 50) and offset (default 0).

The retention archive holds what archive policies moved out of the live tables: a read-only JSON copy of each resource (and a file's bytes), until delete_after, when it is deleted. Nothing in it is reachable through any other endpoint, and nothing is ever restored from it. A cascaded file names the record it went with in parent_resource_type and parent_resource_id; a chat room's messages are inside the room's copy.

BANK_ID is the space: a bank's id, or SYS for the system space. The Role is checked at that BANK_ID.

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

URL Parameters:

BANK_ID: gh.29.uk

JSON response body fields (12)
archived_at
archived_at
bank_id
gh.29.uk
has_content
has_content
resource_id
resource_id
resource_type
resource_type
retention_archive_entries
retention_archive_entries
retention_archive_id
retention_archive_id
retention_run_id
retention_run_id
delete_after
delete_after
entity_name
EXAMPLE COMPANY LTD
owner_user_id
owner_user_id
retention_policy_id
retention_policy_id
Example success response 
{
  "retention_archive_entries": [
    {
      "retention_archive_id": "5c4b3a29-1807-4f6e-8d5c-4b3a29180706",
      "retention_policy_id": "6a1f0e2c-3b8d-4c5e-9f7a-1d2e3f4a5b6c",
      "retention_run_id": "0b9c8d7e-6f5a-4b3c-2d1e-0f9e8d7c6b5a",
      "bank_id": "SYS",
      "resource_type": "dynamic_entity_record",
      "resource_id": "3d2c1b0a-9f8e-4d7c-6b5a-4f3e2d1c0b9a",
      "entity_name": "application",
      "owner_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "archived_at": "2026-01-01T00:00:00Z",
      "delete_after": "2031-01-01T00:00:00Z",
      "has_content": false
    }
  ]
}
Possible errors (5)
  • OBP-30001: Bank not found. Please specify a valid value for BANK_ID.
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-30620: Invalid query parameter for data retention.
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 getRetentionArchiveEntries