Skip to main content
Use this endpoint to retrieve the full details of a single coaching period, including its date range, review window status, and team digest. The team digest becomes available once digest_status transitions to completed. Always check digest_status before attempting to read digest content to avoid acting on incomplete data.

​
Endpoint

​
Authentication

Include your API key in the request header:

​
Path Parameters

​
string
required
The unique identifier of the coaching period to retrieve. You can obtain period IDs from the List Periods endpoint.

​
Response

​
200 — Success

Returns a CoachingPeriodDetail object. This extends the base CoachingPeriod fields with digest content once processing is complete.
​
string
Unique identifier for the coaching period (UUID).
​
string
The cadence for this period: weekly, semimonthly, or monthly.
​
string
Calendar date on which call data collection begins (inclusive). Format: YYYY-MM-DD.
​
string
Calendar date on which call data collection ends (inclusive). Format: YYYY-MM-DD.
​
string
Inclusive UTC calendar-date deadline for agents to complete their coaching agendas. Format: YYYY-MM-DD.
​
string
open through the end of review_period_end in UTC; closed thereafter.
​
string
Processing status of the team digest. pending while being generated; completed when the digest content is available.
​
string
ISO-8601 timestamp of when the period record was created.
​
string
ISO-8601 timestamp of the most recent update to this period record.

​
400 — Bad Request

The periodId path parameter is malformed.

​
401 — Unauthorized

Your API key is missing or invalid.

​
404 — Not Found

No coaching period with the given periodId exists in your organization.

​
Example Request

​
Example Response

Check digest_status == "completed" before reading digest content. Digest content is only available on this detail endpoint once processing is complete.