Read Stored object

GET

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

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

Read an existing instance.

Typed reference to a binary blob held in Aerandil’s S3-compatible object storage. Holds the storage key, content type, size, and checksum — never the bytes, which are uploaded and downloaded directly via presigned URLs. The structural contract mirrors external_record_reference: a reference, never a payload.

Authorizations

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

properties

required

object

backend

required

Storage backend

string

Allowed values: s3

bucket

Bucket

string

byte_size

Verified size in bytes

integer

checksum_sha256

Verified SHA-256 (base64)

string

content_category

Content category

string

Allowed values: identity_document contract invoice folio_document photo menu signature other

content_type

required

Content type (MIME)

string

etag

Storage ETag

string

host_id

required

Host entity id

string

host_kind

required

Host entity kind

string

Allowed values: person reservation property work_order room invoice checklist_result work_order_entry asset guest_feedback lost_found_item checkpoint_result housekeeping_task_entry

required

Stored-object id

string

max_bytes

Declared maximum size in bytes

integer

original_filename

Original filename

string

status

required

Lifecycle status

string

Allowed values: pending available deleted

storage_key

Storage key

string

uploaded_at

Upload confirmed at

string format: date-time

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.stored_object",
  "properties": {
    "backend": "s3",
    "content_category": "identity_document",
    "host_kind": "person",
    "status": "pending"
  },
  "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).