IMimperfect
goals

Read Goal Detail

Changed on

One goal in full, for the conversation that settled it.

The owner's read: the page every reader gets (#3057), plus the goal id every write takes, the status, and whether an app holds it. Owning it means holding the goals cookie, exactly as it does for publishing: an athlete settles goals before they have an account, so the browser session IS the identity here (#1851). Since #2635 an install's Firebase uid resolves that same session, and on the bearer the account that holds the goal reads it too (:func:_readable_goal_or_404), so the app reads every goal its account holds and nobody else's.

Safe, so the cookie alone is enough — no CSRF token and no Origin, like the conversation read. A goal owned by someone else 404s rather than 403s, so the status code cannot be used to tell a real goal id from an invented one.

get/goals/{goal_id}

Request

  • Base URL
    https://api.imperfect.co (the document declares no server; this is the origin it was published from)
  • URL
    https://api.imperfect.co/goals/{goal_id}
  • Auth
    HTTP bearer

Path parameters

goal_idstring required

Headers

x-device-timezonestring nullable
x-device-hintstring nullable
x-client-platformstring nullable

Response

Successful Response

namestring required
linestring nullable
localestring required
kind'destination' | 'practice' required
sportstring nullable
set_atstring date-time required
anchor_kind'event' | 'route' nullable
factorsobject[]
page_expected_untilstring date-time nullable
goal_idstring required
status'exploring' | 'proposing' | 'settled' required
share_idstring nullable
slugstring nullable
published_atstring date-time nullable
claimed_atstring date-time nullable

Changes

  • c009be4558a1Revision changes
    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

  • c98bfec83142Revision changes
    • info

      added the optional property to the response with the status