Skilljar tags API

The tags API from Skilljar — 2 operation(s) for tags.

OpenAPI Specification

skilljar-tags-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Skilljar Assets tags 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: tags
paths:
  /v1/tags:
    get:
      operationId: tags_list
      description: List Tags.  Returns a paginated list (1000 results per page) of Tags.
      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:
      - tags
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTagList'
          description: ''
    post:
      operationId: tags_create
      description: Creates a new `Tag`.
      tags:
      - tags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TagRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TagRequest'
        required: true
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: ''
  /v1/tags/{tag_id}:
    get:
      operationId: tags_retrieve
      description: Get Tag details.
      parameters:
      - in: path
        name: tag_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - tags
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: ''
    put:
      operationId: tags_update
      description: Update Tag details. PUT and PATCH are identical - both do partial updates.
      parameters:
      - in: path
        name: tag_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - tags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TagRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TagRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TagRequest'
        required: true
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: ''
    patch:
      operationId: tags_partial_update
      description: Update Tag details. PUT and PATCH are identical - both do partial updates.
      parameters:
      - in: path
        name: tag_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - tags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedTagRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedTagRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedTagRequest'
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Tag'
          description: ''
    delete:
      operationId: tags_destroy
      parameters:
      - in: path
        name: tag_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      tags:
      - tags
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
components:
  schemas:
    PaginatedTagList:
      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/Tag'
    PatchedTagRequest:
      type: object
      description: Serializer for Tag model.
      properties:
        name:
          type: string
          minLength: 1
          description: Name of the tag.  This is a required field and must be unique within the organization.
          maxLength: 255
    Tag:
      type: object
      description: Serializer for Tag model.
      properties:
        id:
          type: string
          readOnly: true
          description: Known as tag_id within the documentation
        name:
          type: string
          description: Name of the tag.  This is a required field and must be unique within the organization.
          maxLength: 255
        slug:
          type: string
          readOnly: true
          description: The slug can only contain lowercase letters, numbers and dashes.
          maxLength: 255
      required:
      - name
    TagRequest:
      type: object
      description: Serializer for Tag model.
      properties:
        name:
          type: string
          minLength: 1
          description: Name of the tag.  This is a required field and must be unique within the organization.
          maxLength: 255
      required:
      - name
  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