Skip to content
aerandil.com
GitHub

Read Federated participation

GET
/v1/object-types/hospitality.federated_participation/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.federated_participation/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

Opt-in / opt-out record for a tenant, property, portfolio, or venue participating in a program. Carries legal basis, DPA / consent references, allowed analysis kinds, participation- specific exclusions, local execution mode, agent installation reference (when execution mode is agent_installation), credential reference (opaque), optional participant-level contribution cap, output access tier, and prospective withdrawal status. Withdrawal excludes future runs after withdrawal_effective_at; already published outputs remain unless quarantined by review (proposal 0021 §4.4 / §10.6).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “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

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.federated_participation
properties
required
object
agent_installation_id
Required when execution mode is agent_installation
string
allowed_analysis_kinds
required
Participant may opt into analytics but not model training
Array<string>
Allowed values: federated_analytics federated_learning private_set_intersection clean_room_query benchmark_export
approved_by_principal
Required for active cross-tenant participation
string
consent_policy_reference
Required if consent is the basis
string
contribution_weight_cap
Participant-specific cap stricter than definition (decimal in [0,1])
string format: decimal
credential_reference
Pointer to operator vault or clean-room credential. No secret material — same `credential_reference_no_secret_material` discipline as proposal 0020.
string
dispatch_endpoint_url
Participant-published HTTPS URL the proposal 0022 dispatcher POSTs signed envelopes to (§6.1). Absent for SSE-only / pull-based profiles — the dispatcher terminal-fails push dispatches to a participation without one. HTTPS-only; http is admissible solely for loopback receivers (local development), mirroring the webhook-subscription rule.
string
dpa_reference
Required for cross-tenant programs
string
enrolled_by_principal
Principal stable id of enroller (human or admin agent)
string
excluded_field_classes
required
Additional local privacy exclusions
Array<string>
excluded_object_types
required
Tenant-specific exclusions
Array<string>
id
required
Participation id
string
legal_basis_kind
required
Contract / legitimate_interest / consent / public_task / not_personal_data / other_reviewed
string
Allowed values: contract legitimate_interest consent public_task not_personal_data other_reviewed
legal_basis_reference
Required except for not_personal_data with reviewer note
string
local_execution_mode
required
How local extraction runs
string
Allowed values: operator_runner agent_installation hosted_connector third_party_clean_room
output_access_level
required
Output-access tier granted to this participant
string
Allowed values: none aggregate_only participant_benchmark model_consumer
participant_object_ref
Property / venue / portfolio id when scope is not tenant. The concrete typed link lives on the link surface for property and venue scopes (proposal §6).
string
participant_scope
required
Tenant / property / portfolio / venue
string
Allowed values: tenant property portfolio venue
privacy_budget_account_id
Optional explicit budget account
string
program_api_name
required
Program joined
string
runner_identity_ref
SPIFFE URI or other identity URI for the runner; matched against the envelope's `participant.runner_identity_ref` at dispatch time (proposal 0022 §8.3).
string
runner_signing_key_ref
Opaque pointer to the runner's Ed25519 verification key in the operator's vault. No key material stored here per `credential_reference_no_secret_material` (proposal 0022 §8.2).
string
status
required
Lifecycle status
string
Allowed values: invited reviewing active paused withdrawn revoked
withdrawal_effective_at
Prospective exclusion point
string format: date-time
withdrawal_reason
Withdrawal reason
string
withdrawal_requested_at
Set when participant withdraws
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.federated_participation",
  "properties": {
    "allowed_analysis_kinds": [
      "federated_analytics"
    ],
    "legal_basis_kind": "contract",
    "local_execution_mode": "operator_runner",
    "output_access_level": "none",
    "participant_scope": "tenant",
    "status": "invited"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “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

Section titled “404”

No object with that id (or soft-deleted).