Preview integration retention

GET/v1/retention/preview

Headers

authorization string required

Bearer workspace API key.

ExampleBearer $NQD_API_KEY

workspace-id string required

Workspace scope for the request. Required for workspace operations and must belong to the authenticated identity.

Minimum length: 1 character. · Maximum length: 128 characters.

Example01JQ2T5Y5Q3R8W9N6M4K2H7P1A

Response

200Success

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

data object

Returned records. Collections and batches use an array; single records use an object.

ShowHide 9 properties

data.policy object

policy for this retention.

ShowHide 5 properties

data.policy.enabled boolean

Whether this option is enabled.

Exampletrue

data.policy.logRetentionDays number

log retention days within policy.

minimum 1 · maximum 3650

Example1

data.policy.deliveryRetentionDays number

delivery retention days within policy.

minimum 1 · maximum 3650

Example1

data.policy.updatedBy string

Identifier of the identity that last updated the record.

Minimum length: 1 character. · Maximum length: 128 characters.

Examplenull

data.policy.updatedAt string

Timestamp used for stale-edit protection. Preserve the server value when updating.

Example2026-01-15T12:00:00.000Z

data.policyRevision string

policy revision for this retention.

Minimum length: 1 character. · Maximum length: 128 characters.

ExampleConsulting services

data.deliveryCandidates number

delivery candidates for this retention.

Example100

data.logCandidates number

log candidates for this retention.

Example100

data.protectedDeliveries number

protected deliveries for this retention.

Example100

data.protectedLogs number

protected logs for this retention.

Example100

data.protectedReasons object[]

protected reasons for this retention.

ShowHide 2 properties

data.protectedReasons[].reason string

Machine-readable reason for the validation issue.

ExampleConsulting services

data.protectedReasons[].count number

count within protected reasons.

Example1

data.oldestDeliveryCandidateAt string

ISO 8601 timestamp for oldest delivery candidate.

Example2026-01-15T12:00:00.000Z

data.oldestLogCandidateAt string

ISO 8601 timestamp for oldest log candidate.

Example2026-01-15T12:00:00.000Z

Possible errors

400 Invalid request

Response headers

x-request-id string

Correlation identifier returned with every response for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

error object

Error details returned for a failed request.

ShowHide 4 properties

error.code string

Stable machine-readable error or resource code.

Exampleinvalid_input

error.message string

Human-readable explanation of the result or error.

ExampleThe request could not be validated.

error.requestId string

Correlation identifier for support and request tracing.

Example550e8400-e29b-41d4-a716-446655440000

error.details object nullable

Additional structured details about the result or error.

ShowHide 1 property

error.details.issues object[]

Structured field issues returned when request validation fails.

ShowHide 3 properties

error.details.issues[].path string | number[]

Field path where the validation issue occurred.

One of: string alternative 1, number alternative 2

Example0 items

error.details.issues[].reason string

Machine-readable reason for the validation issue.

Allowed values: "expected_type", "required", "unexpected_property", "invalid_value", "invalid_json", "invalid_query", "unsupported_media_type", "body_too_large", "body_timeout", "conflicting_scope", "missing_header", "concurrency_required", "invalid_resource_id", "invalid_request"

Exampleinvalid_request

error.details.issues[].code string nullable

Stable machine-readable error or resource code.

Exampleinvalid_input

{
  "error": {
    "code": "invalid_input",
    "message": "The request could not be validated.",
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "details": {
      "issues": [
        {
          "path": [],
          "reason": "invalid_request"
        }
      ]
    }
  }
}

View raw OpenAPI operation

Use the machine-readable contract for client generation and payload validation.

Open OpenAPI contract ↗