Skip to main content
Use this endpoint to retrieve metadata for a single coaching agenda: the period it belongs to, its generation and completion state, and, when available, an authenticated Shilo web deep link the agent can use to open their coaching session. This endpoint does not return the generated agenda’s questions or body content. Use the agenda_url field to deep-link agents into their coaching session from your own app, email notifications, or CRM workflows.

​
Endpoint

​
Authentication

Include your API key in the request header:

​
Path Parameters

​
string
required
The unique identifier of the coaching agenda to retrieve. You can obtain agenda IDs from the List Period Agendas endpoint.

​
Response

​
200 — Success

Returns a CoachingAgenda object.
​
string
Unique identifier for the coaching agenda (UUID).
​
string
The coaching period this agenda was generated for.
​
string
Your Shilo integration identifier.
​
string | null
Shilo user ID of the agent this agenda belongs to. May be null if the user record was removed after agenda generation.
​
string
Your system’s user ID for the agent.
​
string | null
Human-readable title for the agenda (e.g. "June coaching"). May be null if not yet assigned.
​
string
Cadence of the parent coaching period: weekly, semimonthly, or monthly.
​
string
ISO-8601 date marking the start of the parent coaching period.
​
string
ISO-8601 date marking the end of the parent coaching period.
​
string
ISO-8601 date marking the end of the review window during which the agent can submit the agenda.
​
string
Generation status of the agenda. One of queued, processing, ready, failed, or not_eligible.
​
boolean
Whether the agent has completed the agenda.
​
string | null
ISO-8601 timestamp of when the agent completed the agenda. null if not completed.
​
boolean | null
Whether the agenda was completed before review_period_end. null if not completed.
​
boolean
Whether post-submission analysis has produced a stored summary.
​
string | null
Authenticated Shilo web deep link the agent can use to open their coaching session. Present only for ready agendas with exactly one active user mapping. Requires normal Shilo web authentication and does not contain an API key or login token. null otherwise.
​
string
ISO-8601 timestamp of when the agenda was created.
​
string
ISO-8601 timestamp of the most recent update to this agenda.

​
400 — Bad Request

The agendaId path parameter is malformed.

​
401 — Unauthorized

Your API key is missing or invalid.

​
404 — Not Found

No coaching agenda with the given agendaId exists in your organization.

​
Example Request

​
Example Response

Use the agenda_url field to link agents directly to their coaching agenda from your own app or notification system. The link opens the agent’s coaching session in Shilo and requires normal Shilo web authentication; it does not carry an API key or login token.