Stella Connect (Medallia Agent Connect) Coaching API

The Coaching API from Stella Connect (Medallia Agent Connect) — 1 operation(s) for coaching.

OpenAPI Specification

stellaconnect-coaching-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Agent Connect Coaching API
  description: Agent Connect API
  termsOfService: https://medallia.com/about/legal/terms/api
  version: 1.0.0
servers:
- url: https://{subdomain}.api.stellaconnect.net
  variables:
    subdomain:
      description: Subdomain for the Agent Connect API
      default: subdomain
security:
- ApiKeyInHeader: []
  JwtAuth: []
tags:
- name: Coaching
paths:
  /v2/coaching/sessions:
    get:
      summary: 1:1 Coaching Sessions
      parameters:
      - name: Authorization
        in: header
        description: Token
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '[insert your token here]'
      - name: x-api-key
        in: header
        description: Production API Key
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '[insert your API key here]'
      - name: created_at_gte
        in: query
        description: Request Coaching Sessions created after or at the specified date and time
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2025-12-20T00:00:00-05:00'
      - name: created_at_lte
        in: query
        description: Request Coaching Sessions created before or at the specified date and time
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2025-12-20T00:00:00-05:00'
      - name: shared_at_gte
        in: query
        description: Request Coaching Sessions completed after or at the specified date and time
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2025-12-20T00:00:00-05:00'
      - name: shared_at_lte
        in: query
        description: Request Coaching Sessions completed before or at the specified date and time
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2025-12-20T00:00:00-05:00'
      - name: after
        in: query
        description: Request Coaching Sessions after the specified Sequence ID
        required: false
        style: form
        explode: true
        schema:
          maxLength: 1024
          type: string
        example: '1000'
      responses:
        '200':
          description: For a 200 response code, the response body contains an array of 1:1 Coaching Sessions.
          headers:
            Content-Type:
              style: simple
              explode: false
              schema:
                type: string
              example: application/json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBodyDataReturn_CoachingSessions'
        '403':
          description: Forbidden — The request was denied due to an authentication failure.
        '500':
          description: Internal Server Error — The server encountered an unexpected condition that prevented it from fulfilling the request. File a Support ticket if this error is reproducible.
      tags:
      - Coaching
components:
  schemas:
    ResponseBodyDataReturn_CoachingSessions:
      type: object
      properties:
        uuid:
          type: string
          description: The universal unique identifier for this Coaching Session
        created_at:
          type: string
          description: The time the Coaching Session was created
          format: date-time
        shared_at:
          type: string
          description: The time the Coaching Session was shared by the coach
          format: date-time
        reshared_at:
          type: string
          description: The time the Coaching Session recap was sent by the coach
          format: date-time
        archived:
          type: boolean
          description: A flag to indicate whether the Coaching Session has been archived
        sequence_id:
          type: integer
          description: The Sequence ID of the Coaching Session
        coach:
          type: object
          properties:
            custom_id:
              type: string
              description: Client-supplied custom ID of the employee who started the Coaching Session
            email:
              type: string
              description: Email address of the coach employee who started the Coaching Session
            first_name:
              type: string
              description: First name of the coach employee who started the Coaching Session
            last_name:
              type: string
              description: Last name of the coach employee who started the Coaching Session
          additionalProperties: false
          description: Details about the coach employee who started the Coaching Session
        employee:
          type: object
          properties:
            custom_id:
              type: string
              description: Client-supplied custom ID of the coachee
            email:
              type: string
              description: Email address of the coachee
            first_name:
              type: string
              description: First name of the coachee
            last_name:
              type: string
              description: Last name of the coachee
            team_leader:
              type: object
              properties:
                custom_id:
                  type: string
                  description: Client-supplied custom ID of the coachee’s team leader
                email:
                  type: string
                  description: Email address of the coachee’s team leader
                first_name:
                  type: string
                  description: First name of the coachee’s team leader
                last_name:
                  type: string
                  description: Last name of the coachee’s team leader
              additionalProperties: false
              description: Details about the coachee’s team leader
          additionalProperties: false
          description: Details about the coachee
        title:
          type: string
          description: Title of the Coaching Session
        private:
          type: boolean
          description: True if the Coaching Session was marked as Private
        created_action_items:
          type: object
          properties:
            text:
              type: string
              description: Text of the Action Item
            category:
              type: string
              description: Category of the Action Item
            status:
              type: string
              description: Status of the Action Item (open/completed)
            created_at:
              type: string
              description: The time the Action Item was created
              format: date-time
            completed_at:
              type: string
              description: The time the Action Item was completed
              format: date-time
            due_date:
              type: string
              description: Due date set for the Action Item
              format: date-time
            owner:
              type: object
              properties:
                custom_id:
                  type: string
                  description: Client-supplied custom ID of the Action Item owner
                email:
                  type: string
                  description: Email address of the Action Item owner
                first_name:
                  type: string
                  description: First name of the Action Item owner
                last_name:
                  type: string
                  description: Last name of the Action Item owner
              additionalProperties: false
              description: Details about the Action Item owner
          additionalProperties: false
          description: Details about Action Items created during the Coaching Session
        completed_action_items:
          type: object
          properties:
            text:
              type: string
              description: Text of the Action Item
            category:
              type: string
              description: Category of the Action Item
            status:
              type: string
              description: Status of the Action Item (open/completed)
            created_at:
              type: string
              description: The time the Action Item was created
              format: date-time
            completed_at:
              type: string
              description: The time the Action Item was completed
              format: date-time
            due_date:
              type: string
              description: Due date set for the Action Item
              format: date-time
            owner:
              type: object
              properties:
                custom_id:
                  type: string
                  description: Client-supplied custom ID of the Action Item owner
                email:
                  type: string
                  description: Email address of the Action Item owner
                first_name:
                  type: string
                  description: First name of the Action Item owner
                last_name:
                  type: string
                  description: Last name of the Action Item owner
              additionalProperties: false
              description: Details about the Action Item owner
          additionalProperties: false
          description: Details about Action Items completed during the Coaching Session (will be empty for Coaching Sessions completed prior to October, 2025)
        kudos:
          type: object
          properties:
            text:
              type: string
              description: Text of the Kudos
            created_at:
              type: string
              description: The time the Kudos was created
              format: date-time
          additionalProperties: false
          description: Details about kudos attached to the Coaching Session
        metric_attachments:
          type: object
          properties:
            name:
              type: string
              description: Name of the metric added to the session
            score:
              type: number
              description: The score of the metric added to the session
            start_date:
              type: string
              description: The start date of the metric score added to the session
              format: date-time
            end_date:
              type: string
              description: The end date of the metric score added to the session
              format: date-time
            added_at:
              type: string
              description: The date the metric was added to the session
              format: date-time
            notes:
              type: string
              description: Notes added to the metric within the Coaching Session
          additionalProperties: false
          description: Details about metrics attached to the Coaching Session
        feedback_attachments:
          type: object
          properties:
            uuid:
              type: string
              description: The interaction's unique identifier within Agent Connect's system
            interaction_id:
              type: string
              description: External Interaction ID of the feedback record added to the session
            added_at:
              type: string
              description: The date the Feedback record was added to the Coaching Session
              format: date-time
            notes:
              type: string
              description: Notes from the Feedback record added to the Coaching Session
          additionalProperties: false
          description: Details about Feedback records attached to the Coaching Session
        qa_review_attachments:
          type: object
          properties:
            uuid:
              type: string
              description: The universal unique identifier for this review
            interaction_id:
              type: string
              description: External Interaction ID
            added_at:
              type: string
              description: The date the QA Review was added to the Coaching Session
              format: date-time
            notes:
              type: string
              description: Notes from the QA Review added to the Coaching Session
          additionalProperties: false
          description: Details about QA Reviews attached to the Coaching Session
      additionalProperties: false
  securitySchemes:
    ApiKeyInHeader:
      type: apiKey
      name: x-api-key
      in: header
    JwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT