Read Access credential

GET

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

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

Read an existing instance.

A per-stay physical or virtual credential — the room key card, wristband, or mobile key — bound to a stay so the opaque vendor token a reader picks up at tap time resolves to the stay’s open folio. The token is a locator, never an authenticator (card UIDs are clonable): resolution requires status = active, an unexpired expires_at, and an in-house stay, and every posting is bounded by the credential’s per_charge_cap / daily_cap. Check-out revokes every credential on the stay — a dropped card in the express-checkout box must fail closed.

Authorizations

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

properties

required

object

daily_cap

Access credential daily cap

Maximum total the credential may post per property-local business day

object

amount

required

string format: decimal

currency

required

string format: iso-4217

expires_at

Hard expiry — resolution fails closed past this instant

string format: date-time

required

Credential id

string

issued_at

required

When the credential was issued

string format: date-time

kind

required

Credential form

string

Allowed values: key_card wristband mobile_key other

per_charge_cap

Access credential per charge cap

Maximum amount a single tap may post

object

amount

required

string format: decimal

currency

required

string format: iso-4217

revoked_at

When the credential was revoked

string format: date-time

status

required

Lifecycle status

string

Allowed values: active revoked

token

Opaque vendor token (card UID — present only while active)

string

token_hint

Display fragment of the token (last four) for staff UIs and audit

string

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_credential",
  "properties": {
    "kind": "key_card",
    "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).