Skilljar Groups > Access Code Pools API

openapi: 3.2.0
info:
  title: Skilljar Groups > Access Code Pools 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.
tags:
- name: Groups > Access Code Pools
paths:
  /v1/groups/{group_id}/access-code-pools:
    get:
      operationId: groups_access_code_pools_list
      description: 'List all access code pools assigned to a group.


        Returns a paginated list of access code pools associated with the specified group.'
      parameters:
      - in: path
        name: group_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - 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:
      - Groups > Access Code Pools
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGroupAccessCodePoolList'
          description: ''
      summary: Groups access code pools list
      x-summary-source: derived
    post:
      operationId: groups_access_code_pools_create
      description: 'Assign an access code pool to a group.


        Specify the access code pool to add by its ID.'
      parameters:
      - in: path
        name: group_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - Groups > Access Code Pools
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupAccessCodePoolRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GroupAccessCodePoolRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GroupAccessCodePoolRequest'
        required: true
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupAccessCodePool'
          description: ''
      summary: Groups access code pools create
      x-summary-source: derived
  /v1/groups/{group_id}/access-code-pools/{access_code_pool_id}:
    get:
      operationId: groups_access_code_pools_retrieve
      description: 'Retrieve details about an access code pool assigned to a group.


        Returns information about the access code pool and its association with the group.'
      parameters:
      - in: path
        name: access_code_pool_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: group_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - Groups > Access Code Pools
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupAccessCodePool'
          description: ''
      summary: Groups access code pools retrieve
      x-summary-source: derived
    delete:
      operationId: groups_access_code_pools_destroy
      description: 'Remove an access code pool from a group.


        This action only removes the association; the access code pool itself is not deleted.'
      parameters:
      - in: path
        name: access_code_pool_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: group_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - Groups > Access Code Pools
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Groups access code pools destroy
      x-summary-source: derived
components:
  schemas:
    GroupAccessCodePool:
      type: object
      properties:
        access_code_pool:
          $ref: '#/components/schemas/GroupAccessCodePoolLink'
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: ISO 8601 datetime indicating when the student group / access code link was created
      required:
      - access_code_pool
    GroupAccessCodePoolLink:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          readOnly: true
          description: Name of the access code pool.  This may have been auto-generated when creating individual codes in the dashboard.
      required:
      - id
    PaginatedGroupAccessCodePoolList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/GroupAccessCodePool'
    GroupAccessCodePoolRequest:
      type: object
      properties:
        access_code_pool:
          $ref: '#/components/schemas/GroupAccessCodePoolLinkRequest'
      required:
      - access_code_pool
    GroupAccessCodePoolLinkRequest:
      type: object
      properties:
        id:
          type: string
          minLength: 1
      required:
      - id
  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
x-provenance:
  method: harvested
  publisher: Skilljar
  source: https://api.skilljar.com/docs/schema.yml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)