Skilljar Group Categories API

The Group Categories API from Skilljar — 2 operation(s) for group categories.

OpenAPI Specification

skilljar-group-categories-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Skilljar Assets Group Categories 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: Group Categories
paths:
  /v1/group-categories:
    get:
      operationId: group_categories_list
      description: 'List all group categories.


        Returns a paginated list of group categories that can be used to organize student groups.'
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - Group Categories
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGroupCategoryList'
          description: ''
  /v1/group-categories/{group_category_id}:
    get:
      operationId: group_categories_retrieve
      description: 'Retrieve a specific group category by its ID.


        Returns details for a single group category.'
      parameters:
      - in: path
        name: group_category_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - Group Categories
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupCategory'
          description: ''
components:
  schemas:
    GroupCategory:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
      required:
      - name
    PaginatedGroupCategoryList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/GroupCategory'
  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