Skilljar

Skilljar Domains > Access Codes > Codes API

The Domains > Access Codes > Codes API from Skilljar — 2 operation(s) for domains > access codes > codes.

GitHub OpenAPI

Operations 6

GET /v1/domains/{domain_name}/access-code-pools/{access_code_pool_id}/access-codes Domains access code pools access codes list #
POST /v1/domains/{domain_name}/access-code-pools/{access_code_pool_id}/access-codes Domains access code pools access codes create #
GET /v1/domains/{domain_name}/access-code-pools/{access_code_pool_id}/access-codes/{access_code_id} Domains access code pools access codes retrieve #
PUT /v1/domains/{domain_name}/access-code-pools/{access_code_pool_id}/access-codes/{access_code_id} Domains access code pools access codes update #
PATCH /v1/domains/{domain_name}/access-code-pools/{access_code_pool_id}/access-codes/{access_code_id} Domains access code pools access codes partial update #
DELETE /v1/domains/{domain_name}/access-code-pools/{access_code_pool_id}/access-codes/{access_code_id} Domains access code pools access codes destroy #

Documentation

📖
APIReference
https://api.skilljar.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/skilljar/refs/heads/main/openapi/skilljar-domains-access-codes-codes-api-openapi.yml

Other Resources

🔗
x-openapi-original
https://api.skilljar.com/docs/schema.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/skilljar/refs/heads/main/asyncapi/skilljar-webhooks.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/skilljar/refs/heads/main/scopes/skilljar-scopes.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/skilljar:skilljar-domains-access-codes-codes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

skilljar-domains-access-codes-codes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Skilljar Domains > Access Codes > Codes 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: Domains > Access Codes > Codes
paths:
  /v1/domains/{domain_name}/access-code-pools/{access_code_pool_id}/access-codes:
    get:
      operationId: domains_access_code_pools_access_codes_list
      description: 'List access codes.


        Retrieve a paginated list of access codes in a pool.'
      parameters:
      - in: path
        name: access_code_pool_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: domain_name
        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:
      - Domains > Access Codes > Codes
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedDomainAccessCodeListItemList'
          description: ''
      summary: Domains access code pools access codes list
      x-summary-source: derived
    post:
      operationId: domains_access_code_pools_access_codes_create
      description: 'Create an access code.


        Add a new access code to a pool. The code can be distributed to learners for domain access.'
      parameters:
      - in: path
        name: access_code_pool_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: domain_name
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      tags:
      - Domains > Access Codes > Codes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainAccessCodeDetailRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DomainAccessCodeDetailRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DomainAccessCodeDetailRequest'
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAccessCodeDetail'
          description: ''
      summary: Domains access code pools access codes create
      x-summary-source: derived
  /v1/domains/{domain_name}/access-code-pools/{access_code_pool_id}/access-codes/{access_code_id}:
    get:
      operationId: domains_access_code_pools_access_codes_retrieve
      description: 'Retrieve an access code.


        Get details for a specific access code, including its status, usage limits, and assigned users.'
      parameters:
      - in: path
        name: access_code_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: access_code_pool_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: domain_name
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      tags:
      - Domains > Access Codes > Codes
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAccessCodeDetail'
          description: ''
      summary: Domains access code pools access codes retrieve
      x-summary-source: derived
    put:
      operationId: domains_access_code_pools_access_codes_update
      description: 'Update an access code.


        Update the properties of an existing access code. Both PUT and PATCH requests are supported.'
      parameters:
      - in: path
        name: access_code_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: access_code_pool_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: domain_name
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      tags:
      - Domains > Access Codes > Codes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DomainAccessCodeDetailRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DomainAccessCodeDetailRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DomainAccessCodeDetailRequest'
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAccessCodeDetail'
          description: ''
      summary: Domains access code pools access codes update
      x-summary-source: derived
    patch:
      operationId: domains_access_code_pools_access_codes_partial_update
      description: 'Update an access code.


        Update the properties of an existing access code. Both PUT and PATCH requests are supported.'
      parameters:
      - in: path
        name: access_code_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: access_code_pool_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: domain_name
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      tags:
      - Domains > Access Codes > Codes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDomainAccessCodeDetailRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDomainAccessCodeDetailRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDomainAccessCodeDetailRequest'
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DomainAccessCodeDetail'
          description: ''
      summary: Domains access code pools access codes partial update
      x-summary-source: derived
    delete:
      operationId: domains_access_code_pools_access_codes_destroy
      description: 'Delete an access code.


        Permanently remove an access code from the pool.'
      parameters:
      - in: path
        name: access_code_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: access_code_pool_id
        schema:
          type: string
          pattern: ^[0-9a-z]+$
        required: true
      - in: path
        name: domain_name
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      tags:
      - Domains > Access Codes > Codes
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
      summary: Domains access code pools access codes destroy
      x-summary-source: derived
components:
  schemas:
    DomainAccessCodeUser:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
          format: email
          title: Email address
          readOnly: true
        first_name:
          type: string
          readOnly: true
        last_name:
          type: string
          readOnly: true
      required:
      - id
    PatchedDomainAccessCodeDetailRequest:
      type: object
      properties:
        code:
          type: string
          minLength: 1
          maxLength: 40
        active:
          type: boolean
          default: true
        max_uses:
          type: integer
          minimum: 0
        duration:
          type:
          - integer
          - 'null'
          minimum: 1
        duration_unit:
          $ref: '#/components/schemas/DurationUnitEnum'
    PaginatedDomainAccessCodeListItemList:
      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/DomainAccessCodeListItem'
    DomainAccessCodeDetailRequest:
      type: object
      properties:
        code:
          type: string
          minLength: 1
          maxLength: 40
        active:
          type: boolean
          default: true
        max_uses:
          type: integer
          minimum: 0
        duration:
          type:
          - integer
          - 'null'
          minimum: 1
        duration_unit:
          $ref: '#/components/schemas/DurationUnitEnum'
    DurationUnitEnum:
      enum:
      - MONTHS
      - DAYS
      type: string
      description: '* `MONTHS` - Months

        * `DAYS` - Days'
    DomainAccessCodeDetail:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        code:
          type: string
          maxLength: 40
        active:
          type: boolean
          default: true
        max_uses:
          type: integer
          minimum: 0
        use_count:
          type: integer
          maximum: 2147483647
          minimum: 0
          readOnly: true
        duration:
          type:
          - integer
          - 'null'
          minimum: 1
        duration_unit:
          $ref: '#/components/schemas/DurationUnitEnum'
        users:
          type: array
          items:
            $ref: '#/components/schemas/DomainAccessCodeUser'
          readOnly: true
    DomainAccessCodeListItem:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        code:
          type: string
          maxLength: 40
        active:
          type: boolean
          default: true
        max_uses:
          type: integer
          minimum: 0
        use_count:
          type: integer
          maximum: 2147483647
          minimum: 0
          readOnly: true
        duration:
          type:
          - integer
          - 'null'
          minimum: 1
        duration_unit:
          $ref: '#/components/schemas/DurationUnitEnum'
      required:
      - code
  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