Get retention rule by id | Opik Documentation

GET/v1/private/retention/rules/{ruleId}Get retention rule by id

Get a specific retention rule by id

Parameters

ruleIdstring · uuidpathrequired

Responses

objectRetentionRule_Public

apply_to_pastboolean

catch_up_cursorstring · uuid

Current position of historical data cleanup

catch_up_doneboolean

Whether historical catch-up is complete

created_atstring · date-time

created_bystring

enabledboolean

idstring · uuid

last_updated_atstring · date-time

last_updated_bystring

levelstring

Computed from projectId and organizationLevel

one of "organization", "workspace", "project"

project_idstring · uuid

retentionstringrequired

one of "short_14d", "base_60d", "extended_400d", "unlimited"

workspace_idstring

Example response

{
  "apply_to_past": true,
  "catch_up_cursor": "00000000-0000-0000-0000-000000000000",
  "catch_up_done": true,
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "enabled": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "level": "organization",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "retention": "base_60d",
  "workspace_id": "string"
}

Examples

ruleIdrequiredpath parameter

curl -X GET 'http://localhost:5173/api/v1/private/retention/rules/00000000-0000-0000-0000-000000000000'

const response = await fetch('http://localhost:5173/api/v1/private/retention/rules/00000000-0000-0000-0000-000000000000', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/retention/rules/00000000-0000-0000-0000-000000000000', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/retention/rules/00000000-0000-0000-0000-000000000000")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/retention/rules/00000000-0000-0000-0000-000000000000", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/retention/rules/00000000-0000-0000-0000-000000000000");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/retention/rules/00000000-0000-0000-0000-000000000000"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/retention/rules/00000000-0000-0000-0000-000000000000")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:5173/api/v1/private/retention/rules/00000000-0000-0000-0000-000000000000");
using var response = await client.SendAsync(request);

{
  "apply_to_past": true,
  "catch_up_cursor": "00000000-0000-0000-0000-000000000000",
  "catch_up_done": true,
  "created_at": "2026-06-09T00:00:00Z",
  "created_by": "string",
  "enabled": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "last_updated_at": "2026-06-09T00:00:00Z",
  "last_updated_by": "string",
  "level": "organization",
  "project_id": "00000000-0000-0000-0000-000000000000",
  "retention": "base_60d",
  "workspace_id": "string"
}