Task API Probe

Task API Probe

scripts/hospitable_task_probe.py is a local diagnostic script for inspecting Hospitable task list and detail response structure. It is useful when the integration is not finding a task field or Hospitable changes response shapes.

The script does not store credentials. Provide the Hospitable token through an environment variable only for the shell session running the probe.

Requirements

• Python 3.
• A Hospitable Personal Access Token.
• The repository checked out locally.

No Python package install is required; the script uses only the Python standard library.

List Tasks And Fetch Details

export HOSPITABLE_API_TOKEN="your-token"
export HOSPITABLE_PROPERTY_UUIDS="property-uuid-1,property-uuid-2"
python3 scripts/hospitable_task_probe.py --fetch-detail --limit 3

The output includes:

• Task count.
• Queried date range.
• Top-level task response keys.
• Candidate status and assignment paths.
• Detail response structure for the printed tasks.

Inspect One Task

export HOSPITABLE_API_TOKEN="your-token"
python3 scripts/hospitable_task_probe.py --task-id "task-uuid" --show-values

Use --show-values only locally. It prints candidate status and assignment values from the task detail response so the integration can be updated when Hospitable uses a new field name.

Optional Arguments

• --property: Hospitable property UUID. Can be passed more than once.
• --start-date: Start date for the task query.
• --end-date: End date for the task query.
• --limit: Number of listed tasks to print.
• --max-pages: Maximum task list pages to query.
• --fetch-detail: Call /tasks/{id} for each printed task.
• --show-values: Print candidate field values.

Security

Do not paste real Hospitable tokens into source files, wiki pages, screenshots, or Home Assistant YAML. If a token is exposed during troubleshooting, rotate it in Hospitable after the diagnostic work is complete.