Skilljar Users > Plans API

openapi: 3.0.3
info:
  title: Skilljar Assets Users > Plans API
  version: 1.0.0
  description: 'The Skilljar API provides comprehensive access to our customer education platform, enabling you to programmatically manage courses, users, enrollments, and more.


    This interactive documentation is automatically generated from our codebase and stays current with the latest features and endpoints.


    ## Getting Started


    New to the Skilljar API? Check out these essential resources:


    - **[API Getting Started Guide](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Getting_started_with_the_Skilljar_API)** - Authentication, basic concepts, and your first API call

    - **[Token-based SSO](https://support.gainsight.com/Skilljar/Develop_and_Customize/Single_Sign_on_(SSO)/Configuring_Token-Based_Single_Sign-On_(SSO))** - Seamlessly integrate user authentication

    - **[Webhooks](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Using_Webhooks_API)** - Real-time notifications for platform events

    '
tags:
- name: Users > Plans
paths:
  /v1/users/{user_id}/plan-enrollments:
    get:
      operationId: users_plan_enrollments_list
      description: 'List plan enrollments for a user.


        Returns a list of plan enrollments and related details for the user.'
      parameters:
      - in: path
        name: user_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - Users > Plans
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserPlanEnrollments'
          description: ''
components:
  schemas:
    UserPlanEnrollments:
      type: object
      properties:
        plan_id:
          type: string
          readOnly: true
        domain_name:
          type: string
          readOnly: true
        enrolled_at:
          type: string
          format: date-time
          readOnly: true
        expires_at:
          type: string
          format: date-time
          readOnly: true
        active:
          type: boolean
          readOnly: true
        enrollment_id:
          type: string
        plan:
          allOf:
          - $ref: '#/components/schemas/UserPlanEnrollmentPlan'
          readOnly: true
      required:
      - enrollment_id
    UserPlanEnrollmentPlan:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        title:
          type: string
          readOnly: true
  securitySchemes:
    OrganizationApiKey:
      type: http
      scheme: basic
      description: API key authentication using HTTP Basic Auth. Use your API key as the username and leave password empty.
    tokenAuth:
      type: http
      scheme: bearer