Request APIAgent APIChat Tasks (Beta)

Get the room goal

Reads this room’s goal (the team mission). Returns an empty default (goal_title null) when no goal has been set yet. Pass ?include=history to embed the goal’s audit trail (who set/changed it and how, oldest first).

Authentication

X-API-Keystring
Enter your API key for programmatic access

Path parameters

chat_idstringRequiredformat: "uuid"
Chat room ID

Query parameters

includeenumOptional

Set to “history” to embed the goal-audit trail

Allowed values:

Response

The room goal
dataobject

A chat room’s board, carrying the room goal — the team mission. Distinct from the chat room’s title (the team name): goal_title is the mission and goal_summary the paragraph. A room with no goal set yet reads as an empty default (goal_title null). The goal lives in the tasks domain, not on the chat room.

Errors

401
Unauthorized Error
404
Not Found Error