Skip to content
AiKYNETIX

The portal's home for a card

GET
/api/portal/{client_id}/home/
curl --request GET \
  --url http://localhost:8000/api/portal/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/home/ \
  --header 'Authorization: Bearer <token>'

coach_message is the team’s latest message in the card’s conversation — a preview of its words, who wrote it by name only. coach_name is the coach who last wrote there or last shared a result by hand, whichever was later, by name.

The signed-in person’s grant on the card in the path. Every route answers 404 while client access is switched off on the environment. 404 card_not_found for a card the account never held — another athlete’s, a card of the account’s own team, or an id that names nothing. 403 access_ended (reason: revoked · team_plan · minor) for a card it held and can no longer open, consent_required when the consent texts changed since the person accepted them (consent again with POST /api/portal/{client_id}/consent/). A partner API key gets 403. 429 past the account’s rate (client_portal, 120/min; the PDFs client_portal_pdf, 20/min).

Only what a coach released is visible, curated on the server: the team’s hidden metrics are absent, the coach’s AI text and internal fields are not sent, and media URLs are signed for two hours.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

GET /api/portal/<client_id>/home/ (PortalHome).

object
coach_message
required

The team’s latest message in the card’s conversation — its words cut to a preview, who wrote it by name only; null before any.

object
text
required

A one-line preview of the words.

string
author_name
required

By name only; empty when the coach gave none.

string
created_at
required
string format: date-time
event
required

result_shared, document_shared (#2693 S5), or null.

string
nullable
coach_name
required

The coach who last wrote in the card’s conversation or last shared a result with it by hand, whichever was later, by name; null when neither gave a name (or every result was shared automatically).

string
nullable

Examples

ExampleHome
{
  "coach_message": {
    "text": "Great session today — see the cadence note.",
    "author_name": "Kim Larsen",
    "created_at": "2026-11-02T10:16:00Z",
    "event": null
  },
  "coach_name": "Kim Larsen"
}

401

Section titled “401”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string

Example generated

{
  "detail": "example"
}

403

Section titled “403”
Media typeapplication/json
object
detail
required

access_ended, consent_required, or DRF’s message for a partner API key.

string
reason

With access_ended: why the card no longer opens — revoked, team_plan or minor.

string
client_name
string
team_name
string
consent_version

With consent_required: the version to accept.

string
kinds

With consent_required: the texts to show.

Array<string>

Examples

403 — access ended

The card no longer opens; the page says why and names nothing else of it.

{
  "detail": "access_ended",
  "reason": "revoked",
  "client_name": "Sofia Lebedeva",
  "team_name": "North Track Academy"
}

404

Section titled “404”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string

Examples

Example404—NotACardOfThisAccount

404 — not a card of this account

{
  "detail": "card_not_found"
}

429

Section titled “429”
Media typeapplication/json
object
detail
required

429 — throttled: this account’s (or address’s) rate for the route is used up; try again after wait seconds, which Retry-After repeats. A route with a limit of its own answers its own code instead, documented there.

string
wait

With throttled: whole seconds until the next request can pass.

integer
nullable

Example generated

{
  "detail": "example",
  "wait": 1
}