Read Privacy budget account

GET

/v1/object-types/hospitality.privacy_budget_account/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.privacy_budget_account/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.privacy_budget_account/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

Tracks privacy spend for a participant, program, definition, or composition group. Epsilon / delta totals and the running spent / reserved totals are the durable evidence of DP accounting; replays cannot double-spend (proposal 0021 §4.5 / §9).

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.privacy_budget_account:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.privacy_budget_account

properties

required

object

account_scope

required

tenant_program / property_program / definition / composition_group / output_recipient

string

Allowed values: tenant_program property_program definition composition_group output_recipient

alert_thresholds

Optional thresholds for operator warnings

Array<string>

composition_group

Composition group

string

composition_strategy

required

Basic / advanced / RDP / zCDP / operator_supplied_reviewed

string

Allowed values: basic advanced rdp zcdp operator_supplied_reviewed

definition_api_name

Definition api name

string

delta_total

Required when delta applies

string format: decimal

epsilon_reserved

Defaults 0

string format: decimal

epsilon_spent

Defaults 0

string format: decimal

epsilon_total

Required for DP accounts

string format: decimal

required

Account id

string

last_spend_at

Audit convenience

string format: date-time

mechanism_family

required

Central DP / local DP / DP-SGD / DP clean room / threshold-only

string

Allowed values: central_dp local_dp dp_sgd dp_clean_room none_threshold_only

period_end

Required unless lifetime

string format: date-time

period_kind

required

Run / day / month / quarter / year / lifetime

string

Allowed values: run day month quarter year lifetime

period_start

required

Period start

string format: date-time

program_api_name

required

Program api name

string

status

required

Lifecycle status

string

Allowed values: active reserved exhausted paused closed

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

Example

{
  "object_type": "hospitality.privacy_budget_account",
  "properties": {
    "account_scope": "tenant_program",
    "composition_strategy": "basic",
    "mechanism_family": "central_dp",
    "period_kind": "run",
    "status": "active"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).