Read Consent policy

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.consent_policy/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.consent_policy/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

Tenant-scoped, versioned consent policy. Authorises the ConsentScope envelopes embedded on objects and events: its default_scope is the deny-by-omission grant applied to any object without its own scope, purposes_grantable bounds what a scope may grant, and min_cohort_size is the kernel-level k-anonymity floor enforced on derived inference outputs. Versioned per the monotonic-version contract; verified_by records DPO sign-off.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.consent_policy: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.consent_policy

properties

required

object

authored_by

required

Principal::stable_id() of the author

string

default_scope

required

Default `ConsentScope` applied to objects without their own scope

effective_from

required

When this policy version takes effect

string format: date-time

effective_until

When this policy version is superseded

string format: date-time

required

Policy id

string

min_cohort_size

required

Kernel-level k-anonymity floor (AWS Clean Rooms default: 5)

integer

policy_text_uri

Opaque pointer to the human-readable policy document

string

purposes_grantable

required

The purposes this policy is permitted to grant

Array<string>

Allowed values: operational benchmark_aggregate federated_query federated_training model_distillation fraud_network

regulatory_basis

required

Regulatory regime this policy is written under (GDPR / CCPA / UK DUA …)

string

verified_by

Principal::stable_id() of the DPO sign-off, when verified

string

version

required

Monotonic policy version (a new grant strictly increases it)

integer

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.consent_policy",
  "properties": {
    "purposes_grantable": [
      "operational"
    ]
  },
  "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).