Skilljar Domains API
The Domains API from Skilljar — 4 operation(s) for domains.
The Domains API from Skilljar — 4 operation(s) for domains.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/skilljar-domains-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Skilljar Domains 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
paths:
/v1/domains:
get:
operationId: domains_list
description: 'List all domains.
Returns a paginated list of domains for your organization,
including their names, access settings, and catalog titles.'
parameters:
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
tags:
- Domains
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedDomainList'
description: ''
summary: Domains list
x-summary-source: derived
/v1/domains/{domain_name}:
get:
operationId: domains_retrieve
description: 'Retrieve a domain.
Returns details for a specific domain,
including its name, catalog title, access settings, and marketing messages.'
parameters:
- in: path
name: domain_name
schema:
type: string
pattern: ^[-:\.0-9a-z]+$
required: true
tags:
- Domains
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
description: ''
summary: Domains retrieve
x-summary-source: derived
put:
operationId: domains_update
description: 'Update a domain.
Allows updating one or more fields of a domain. Both PUT and PATCH requests perform partial updates.'
parameters:
- in: path
name: domain_name
schema:
type: string
pattern: ^[-:\.0-9a-z]+$
required: true
tags:
- Domains
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DomainRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DomainRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
description: ''
summary: Domains update
x-summary-source: derived
patch:
operationId: domains_partial_update
description: 'Partially update a domain.
Allows updating specific fields of a domain.'
parameters:
- in: path
name: domain_name
schema:
type: string
pattern: ^[-:\.0-9a-z]+$
required: true
tags:
- Domains
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDomainRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedDomainRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDomainRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Domain'
description: ''
summary: Domains partial update
x-summary-source: derived
/v1/domains/{domain_name}/catalog-pages/{catalog_page_id}/visibility-overrides:
get:
operationId: domains_catalog_pages_visibility_overrides_list
description: List Student Group visibility overrides for a given Catalog Page.
parameters:
- in: path
name: catalog_page_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
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCatalogPageGroupVisibilityList'
description: ''
summary: Domains catalog pages visibility overrides list
x-summary-source: derived
post:
operationId: domains_catalog_pages_visibility_overrides_create
description: Create a Student Group visibility override for a Catalog Page.
parameters:
- in: path
name: catalog_page_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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogPageGroupVisibilityRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CatalogPageGroupVisibilityRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/CatalogPageGroupVisibilityRequest'
required: true
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogPageGroupVisibility'
description: ''
summary: Domains catalog pages visibility overrides create
x-summary-source: derived
/v1/domains/{domain_name}/catalog-pages/{catalog_page_id}/visibility-overrides/{student_group_id}:
get:
operationId: domains_catalog_pages_visibility_overrides_retrieve
description: 'Retrieve Student Group visibility override for Catalog Page.
Returns Student Group information and visibility status.'
parameters:
- in: path
name: catalog_page_id
schema:
type: string
pattern: ^[0-9a-z]+$
required: true
- in: path
name: domain_name
schema:
type: string
pattern: ^[-:\.0-9a-z]+$
required: true
- in: path
name: student_group_id
schema:
type: string
pattern: ^[0-9a-z]+$
required: true
tags:
- Domains
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogPageGroupVisibility'
description: ''
summary: Domains catalog pages visibility overrides retrieve
x-summary-source: derived
delete:
operationId: domains_catalog_pages_visibility_overrides_destroy
description: Deletes a Student Group visibility override for a Catalog Page and returns a `204` response.
parameters:
- in: path
name: catalog_page_id
schema:
type: string
pattern: ^[0-9a-z]+$
required: true
- in: path
name: domain_name
schema:
type: string
pattern: ^[-:\.0-9a-z]+$
required: true
- in: path
name: student_group_id
schema:
type: string
pattern: ^[0-9a-z]+$
required: true
tags:
- Domains
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'204':
description: No response body
summary: Domains catalog pages visibility overrides destroy
x-summary-source: derived
components:
schemas:
Domain:
type: object
properties:
id:
type: string
readOnly: true
name:
type: string
readOnly: true
catalog_title:
type: string
description: HTML content displayed at the top of the catalog page
private:
type: boolean
readOnly: true
description: Use the access field to determine domain access
deprecated: true
access:
allOf:
- $ref: '#/components/schemas/AccessEnum'
description: 'Domain access settings
* `PUBLIC` - Public: catalog is visible to anyone.
* `PRIVATE` - Login required: catalog is visible once the user signs up.
* `PRIVATE_CODE` - Access code required: catalog is visible once the user signs up with an access code.'
access_code_message_html:
type: string
marketing_message:
type: string
description: This field has been replaced by the use of Signup Fields.
deprecated: true
DomainRequest:
type: object
properties:
catalog_title:
type: string
minLength: 1
description: HTML content displayed at the top of the catalog page
access:
allOf:
- $ref: '#/components/schemas/AccessEnum'
description: 'Domain access settings
* `PUBLIC` - Public: catalog is visible to anyone.
* `PRIVATE` - Login required: catalog is visible once the user signs up.
* `PRIVATE_CODE` - Access code required: catalog is visible once the user signs up with an access code.'
access_code_message_html:
type: string
minLength: 1
marketing_message:
type: string
description: This field has been replaced by the use of Signup Fields.
deprecated: true
PaginatedDomainList:
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/Domain'
PatchedDomainRequest:
type: object
properties:
catalog_title:
type: string
minLength: 1
description: HTML content displayed at the top of the catalog page
access:
allOf:
- $ref: '#/components/schemas/AccessEnum'
description: 'Domain access settings
* `PUBLIC` - Public: catalog is visible to anyone.
* `PRIVATE` - Login required: catalog is visible once the user signs up.
* `PRIVATE_CODE` - Access code required: catalog is visible once the user signs up with an access code.'
access_code_message_html:
type: string
minLength: 1
marketing_message:
type: string
description: This field has been replaced by the use of Signup Fields.
deprecated: true
AccessEnum:
enum:
- PUBLIC
- PRIVATE
- PRIVATE_CODE
type: string
description: '* `PUBLIC` - Public: catalog is visible to anyone.
* `PRIVATE` - Login required: catalog is visible once the user signs up.
* `PRIVATE_CODE` - Access code required: catalog is visible once the user signs up with an access code.'
CatalogPageGroupVisibilityRequest:
type: object
description: Serializer for CatalogPageGroupVisibility overrides
properties:
student_group:
$ref: '#/components/schemas/StudentGroupSummaryRequest'
is_visible:
type: boolean
required:
- is_visible
- student_group
StudentGroupSummary:
type: object
description: Serializer for student groups for use GroupVisibility serializers
properties:
id:
type: string
name:
type: string
readOnly: true
required:
- id
StudentGroupSummaryRequest:
type: object
description: Serializer for student groups for use GroupVisibility serializers
properties:
id:
type: string
minLength: 1
required:
- id
PaginatedCatalogPageGroupVisibilityList:
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/CatalogPageGroupVisibility'
CatalogPageGroupVisibility:
type: object
description: Serializer for CatalogPageGroupVisibility overrides
properties:
student_group:
$ref: '#/components/schemas/StudentGroupSummary'
is_visible:
type: boolean
required:
- is_visible
- student_group
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