Read Access purpose

GET

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

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

Read an existing instance.

An operator-defined purpose for accessing marked data — the PBAC vocabulary entry (e.g. chargeback investigation). Names the marking compartments it can unlock (covered_markings) and bounds how long a grant of it may live. A purpose is a definition, not a permission: nothing is conferred until a purpose_grant is approved. While a tenant has an active purpose covering a marking and the deployment enforces PBAC, bearer clearances for that marking require an active grant.

Authorizations

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

properties

required

object

covered_markings

required

Marking api-names this purpose can unlock (JSON array, e.g. ["pii.guest"]); validated against the registered marking catalogue

display_name

required

Operator-facing name

string

required

Purpose id

string

justification

required

Why this purpose exists — the standing business/legal ground grants under it inherit (distinct from each grant's own rationale)

string

max_grant_hours

Ceiling on a grant's lifetime under this purpose; a `request_purpose_grant` asking for longer is rejected

integer

status

required

Lifecycle status

string

Allowed values: active retired

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.access_purpose",
  "properties": {
    "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).