Get host profile — Calendar

Read the selected workspace host, including the unconfigured host:null state.

Action: app_topolo_calendar.host.get · GET /api/admin/me

Declared permission: app_topolo_calendar.host:read. For authorized Calendar users; permissions and resource access still apply.

Before you start

• Use the current credential to confirm the production organization and inspect this exact action before preparing a call.
• Declared permission: app_topolo_calendar.host:read. Permission discovery is not a grant.
• Discover the authorized Calendar workspace and pass it as resourceType=workspace/resourceId separately from this action input. Calendar records and IDs are scoped to the selected host/workspace.

Inputs and field meanings

No action input fields. Supply the empty JSON object {}; keep resource context separate.

Worked request and response

Source-reviewed illustration only. Nothing below was executed; all identifiers, counts, states, credentials and URLs are synthetic. Replace identifiers through discovery before any separately authorized call.

Resource context: workspace; it is not an extra action input field.

Illustrative action input:

{}

Illustrative HTTP 200 source response:

{
  "auth": {
    "appId": "app_calendar_example",
    "workspaceId": "ws_calendar_example",
    "user": {
      "id": "usr_example",
      "email": "host@example.com",
      "name": "Example Host",
      "orgId": "org_example",
      "role": "owner",
      "permissions": [
        "host:read"
      ]
    },
    "organizationName": "Example organization"
  },
  "host": {
    "id": "hst_example",
    "organizationId": "org_example",
    "workspaceId": "ws_calendar_example",
    "topoloUserId": "usr_example",
    "handle": "example-generated-handle",
    "displayName": "Example Studio",
    "avatarUrl": null,
    "headline": null,
    "bio": null,
    "timezone": "Asia/Dubai"
  }
}

auth identifies the verified context; host.id and generated handle identify the profile. If no host exists, host is null and host.update is the next setup step. Do not choose a caller-supplied handle.

This source-shaped illustrative response does not validate against the declared output schema: overlapping oneOf branches accept the same object. Preserve the schema and report the contract issue; do not claim this is runtime failure evidence.

Effects and verification

• Reads the current user’s host in the selected organization/workspace.

1. Match auth context and host.workspaceId before any setup or booking mutation.

Refusals and recovery

Selected source refusals are listed below; runtime middleware can return additional structured errors.

Recovery: This read does not mutate Calendar records. Correct the selected context or request fields before another authorized read.

Related actions

• app_topolo_calendar.host.update: Create the first host or replace its editable profile fields.
• app_topolo_calendar.availability.get: Read the current host’s complete weekly rules and date overrides.

Declared schemas and provenance

The hidden action guide carries these exact current declared schemas. They are not rewritten to make the illustrations pass.

Input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Output schema:

{
  "title": "Get host profile response",
  "description": "Resource response returned by host.get. The service may return the resource directly or in an envelope.",
  "oneOf": [
    {
      "type": "object",
      "title": "host record",
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable identifier when the host exposes one."
        }
      },
      "additionalProperties": true
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "type": "object",
          "title": "host record",
          "properties": {
            "id": {
              "type": "string",
              "description": "Stable identifier when the host exposes one."
            }
          },
          "additionalProperties": true
        },
        "host": {
          "type": "object",
          "title": "host record",
          "properties": {
            "id": {
              "type": "string",
              "description": "Stable identifier when the host exposes one."
            }
          },
          "additionalProperties": true
        }
      },
      "additionalProperties": true
    }
  ],
  "x-topolo-contract-source": "derived-action-metadata",
  "x-topolo-contract-precision": "structural"
}

Source: TopoloCalendar@b378ceb73800ee1d1e6c4ff6f0b4179918cf632c, apps/api/src/routes/admin-host.ts. Current catalog metadata and source were compared without executing the application.

• Source-reviewed synthetic input/response; not captured or executed.
• Source revision is not proof of current deployment, caller access, provider connection or notification delivery.
• This source-shaped illustrative response does not validate against the declared output schema: overlapping oneOf branches accept the same object. Preserve the schema and report the contract issue; do not claim this is runtime failure evidence.
• This worked example assumes an existing profile. The same source also returns {auth,host:null} for a new workspace.