Skip to main content
API reference sections

Schema

DeletedProfileListing

One restorable Profile deletion as GET /v1/profiles/deleted lists it: the Store's record, plus the name of the retained Profile row so a Trash surface can say which Profile it is without a second read.

Type object

Shape

FieldTypeDescription
namestring or null

The retained Profile row's name. None only when the row is gone, which the Store does not do while a deletion is restorable.

Default null

profilerequiredProfileId
deletionrequiredDeletionId

DeletionId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.

batch_idrequiredBatchId

BatchId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path.

at_msrequiredinteger (int64)
retention_msrequiredinteger (int64)
targetsrequiredarray of WorkspaceId

The captured targets, from the job.

expired_or_purgedrequiredarray of WorkspaceId

Targets whose content is gone or past its retention at now: a restore will report them honestly rather than recreate them.

Example
{
  "name": "string",
  "profile": "00000000-0000-4000-8000-000000000000",
  "deletion": "00000000-0000-4000-8000-000000000000",
  "batch_id": "00000000-0000-4000-8000-000000000000",
  "at_ms": 0,
  "retention_ms": 0,
  "targets": [
    "00000000-0000-4000-8000-000000000000"
  ],
  "expired_or_purged": [
    "00000000-0000-4000-8000-000000000000"
  ]
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.