Skip to main content
Use this endpoint to retrieve metadata for all coaching agendas associated with a specific coaching period. Each item includes the agenda’s generation and completion state and, when available, an authenticated Shilo web deep link. This endpoint does not return the generated agendas’ questions or body content. Results include agendas of all statuses, including those still queued or processing, those that failed generation, and agents who were not eligible during that period.

Endpoint

Authentication

Include your API key in the request header:

Path Parameters

string
required
The unique identifier of the coaching period whose agendas you want to list. Obtain period IDs from the List Periods endpoint.

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 agenda creation date. Accepted values: asc, desc.
string
Filter results to a specific agent’s agenda. Accepted formats:
  • id:{uuid} — prefixed Shilo UUID
  • external_user_id:{string} — your system’s user ID
  • {uuid} — bare Shilo UUID

Response

200 — Success

Returns a CoachingAgendasResponseDto object containing a data array of CoachingAgenda objects and a pagination block.
array
Array of coaching agenda objects for this period.
object
Pagination metadata.

400 — Bad Request

The periodId path parameter or one or more query parameters contain invalid values.

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

This endpoint returns agendas of all statuses: queued, processing, ready, failed, and not_eligible. Filter on the generation_status field in your application to show only relevant records to managers or agents.