Skip to main content
Use this endpoint to retrieve the list of coaching periods generated for your Shilo integration. Each period represents a discrete time window during which call data is collected for agent coaching agendas. You can use this endpoint to discover active and past periods, check whether the review window is still open, and determine whether the team digest has been generated yet.

Endpoint

Authentication

Include your API key in the request header:

Query Parameters

number
default:"50"
Maximum number of results to return per page. Maximum value is 100.
string
Pagination cursor from a previous response’s pagination.next_cursor. Omit to start from the beginning.
string
default:"desc"
Sort order by created date. Accepted values: asc, desc. Defaults to desc so the most recent period appears first.
string
Filter results to a specific coaching cadence. Accepted values: monthly, semimonthly, weekly. Omit to return periods of all cadences.

Response

200 — Success

Returns a CoachingPeriodsResponseDto containing a data array of coaching period objects and a pagination block.
array
Array of coaching period objects.
object
Pagination metadata.

400 — Bad Request

One or more query parameters contain invalid values.

401 — Unauthorized

Your API key is missing or invalid.

Example Request

Example Response

review_status is open through the end of review_period_end in UTC, and transitions to closed after that deadline passes. Use this field to determine whether agents can still submit their agendas for the period.