Read Purpose grant

GET

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

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

Read an existing instance.

One principal’s hold on an access_purpose: requested with a recorded rationale, approved through an ordinary 0020 approval gate (the grant implements the approvable interface; the gate decision transitions it), alive until expires_at (the §9.1 sweep expires it — the grant implements expirable) or an operator revocation. Terminal grants are kept: the row is the audit answer to who could touch this marking, under what purpose, on whose approval, and why.

Authorizations

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

properties

required

object

decided_at

When the approval gate decided (or an operator revoked)

string format: date-time

expires_at

When an `active` grant lapses (the expiry sweep transitions it); bounded by the purpose's `max_grant_hours`

string format: date-time

external_reference

Opaque ref to the driving case (ticket, investigation, DSAR)

string

required

Grant id

string

principal_id

The holding principal's stable id (`user:<uuid>` / `service:<name>` / `agent:<vendor>/<model>@<version>`)

string

purpose_ref

required

Business id of the `access_purpose` this grant confers (also linked via `purpose_grant_for_purpose`)

string

rationale_text

The requester's recorded rationale — why this principal needs this purpose now. The PBAC audit artefact; bounded prose, not a ticket link (put references in external_reference)

string

requested_at

required

When the grant was requested

string format: date-time

status

required

Lifecycle status

string

Allowed values: requested active rejected revoked expired

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.purpose_grant",
  "properties": {
    "status": "requested"
  },
  "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).