Retrieve 1:1 Coaching Settings — Shilo Coaching API

Use this endpoint to inspect the current 1:1 Coaching configuration for your Shilo integration. The response tells you whether coaching is enabled, how frequently coaching periods are generated (cadence), any custom focus text or questions that have been configured for your organization, and the usage limits that govern how much AI coaching content can be generated per period.

Endpoint

GET https://api.shilo.ai/api/v1/coaching/settings

Authentication

Include your API key in the request header:

x-api-key: YOUR_API_KEY

Response

200 — Success

Returns a CoachingSettings object.

string

The unique identifier of your Shilo integration.

boolean

Whether the 1:1 Coaching feature is currently enabled for your integration. This is the configured feature toggle, independent of usage limits.

string

The frequency at which new coaching periods are created. One of: weekly, semimonthly, monthly.

object

Custom coaching content configured for your organization.

Show customization object

string

A free-text coaching focus description that guides the AI when generating agent coaching agendas.

array

Array of custom coaching questions included in every agent agenda.

Show question object

string

Unique identifier for this question.

number

Display order of the question in the agenda (ascending, minimum 0).

string

The text of the coaching question shown to agents.

object

Controls how much AI coaching content can be generated per period.

Show usage_limits object

number | null

Organization-wide coaching limit in seconds. null means unlimited; 0 means coaching generation is fully blocked.

number | null

Per-user coaching limit in seconds. null means unlimited; 0 means coaching generation is fully blocked for each user.

401 — Unauthorized

Your API key is missing or invalid.

404 — Not Found

No coaching settings were found for your integration. Coaching may not yet be configured.

Example Request

curl --request GET \
  --url "https://api.shilo.ai/api/v1/coaching/settings" \
  --header "x-api-key: YOUR_API_KEY"

Example Response

{
  "integration_id": "a3c9e214-1f2b-4d78-bb01-7e5f9c3d0a12",
  "enabled": true,
  "cadence": "weekly",
  "customization": {
    "focus": "Focus on objection handling and discovery question quality.",
    "questions": [
      {
        "id": "q1",
        "order": 0,
        "text": "What was the biggest challenge you faced on calls this week?"
      },
      {
        "id": "q2",
        "order": 1,
        "text": "Which objection did you struggle with most, and how did you handle it?"
      }
    ]
  },
  "usage_limits": {
    "integration_limit_seconds": 36000,
    "per_user_limit_seconds": 3600
  }
}

Overview

Calls

Appointments

Roleplays

Contacts

Users

Invitations

Metrics

Coaching

Retrieve 1:1 Coaching Settings — Shilo Coaching API

Endpoint

Authentication

Response

200 — Success

401 — Unauthorized

404 — Not Found

Example Request

Example Response

​Endpoint

​Authentication

​Response

​200 — Success

​401 — Unauthorized

​404 — Not Found

​Example Request

​Example Response

Endpoint

Authentication

Response

200 — Success

401 — Unauthorized

404 — Not Found

Example Request

Example Response