Skilljar Domains > Catalog Pages API
The Domains > Catalog Pages API from Skilljar — 2 operation(s) for domains > catalog pages.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/skilljar:skilljar-domains-catalog-pages-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Skilljar Domains > Catalog Pages 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 > Catalog Pages
paths:
/v1/domains/{domain_name}/catalog-pages:
get:
operationId: domains_catalog_pages_list
description: Retrieve a paginated list of all catalog pages for the specified domain.
parameters:
- 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
tags:
- Domains > Catalog Pages
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedCatalogPageList'
description: ''
summary: Domains catalog pages list
x-summary-source: derived
post:
operationId: domains_catalog_pages_create
description: Create a new catalog page within the specified domain.
parameters:
- in: path
name: domain_name
schema:
type: string
pattern: ^[-:\.0-9a-z]+$
required: true
tags:
- Domains > Catalog Pages
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogPageCreateRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CatalogPageCreateRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/CatalogPageCreateRequest'
required: true
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogPageCreate'
description: ''
summary: Domains catalog pages create
x-summary-source: derived
/v1/domains/{domain_name}/catalog-pages/{catalog_page_id}:
get:
operationId: domains_catalog_pages_retrieve
description: Retrieve detailed information for a specific catalog page within the domain.
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 > Catalog Pages
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogPage'
description: ''
summary: Domains catalog pages retrieve
x-summary-source: derived
put:
operationId: domains_catalog_pages_update
description: 'Update a specific catalog page within the domain.
Allows partial updates to catalog page fields such as text fields, visibility, etc.'
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 > Catalog Pages
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogPageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/CatalogPageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/CatalogPageRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogPage'
description: ''
summary: Domains catalog pages update
x-summary-source: derived
patch:
operationId: domains_catalog_pages_partial_update
description: 'Partially update a specific catalog page within the domain.
Allows partial updates to catalog page fields such as text fields, visibility, etc.'
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 > Catalog Pages
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCatalogPageRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedCatalogPageRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedCatalogPageRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CatalogPage'
description: ''
summary: Domains catalog pages partial update
x-summary-source: derived
delete:
operationId: domains_catalog_pages_destroy
description: Delete a catalog page from the domain.
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 > Catalog Pages
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'204':
description: No response body
summary: Domains catalog pages destroy
x-summary-source: derived
components:
schemas:
TileSortMethodEnum:
enum:
- catalog_settings_order
- registered_first_completed_last_order
- alphabetically_a_to_z
- alphabetically_z_to_a
type: string
description: '* `catalog_settings_order` - Default Catalog Settings Ordering
* `registered_first_completed_last_order` - Registered, Unregistered, then Completed Courses
* `alphabetically_a_to_z` - Sort alphabetically A to Z
* `alphabetically_z_to_a` - Sort alphabetically Z to A'
CatalogPage:
type: object
properties:
id:
type: string
readOnly: true
page_title:
type: string
description: Title of the catalog page
slug:
type: string
description: URL slug of the catalog page.
pattern: ^[-a-zA-Z0-9_]+$
short_description:
type: string
description: Short description of the catalog page.
maxLength: 300
tile_callout:
type: string
description: Tile callout text for the catalog page when embedded on another catalog page.
maxLength: 15
hidden:
type: boolean
default: false
description: Whether the catalog page is hidden by default.
strict_enforce_group_visibility:
type: boolean
default: false
description: Whether to strictly enforce group visibility.
is_classic:
type: boolean
description: Whether the catalog page is classic, containing only course content, vs. a Builder page containing additional fields.
readOnly: true
url:
type: string
description: Returns the URL of the catalog page.
readOnly: true
header_html:
type: string
description: HTML page header for classic pages.
tile_sort_method:
allOf:
- $ref: '#/components/schemas/TileSortMethodEnum'
default: catalog_settings_order
description: 'Tile sort method for classic pages.
* `catalog_settings_order` - Default Catalog Settings Ordering
* `registered_first_completed_last_order` - Registered, Unregistered, then Completed Courses
* `alphabetically_a_to_z` - Sort alphabetically A to Z
* `alphabetically_z_to_a` - Sort alphabetically Z to A'
search_location:
allOf:
- $ref: '#/components/schemas/SearchLocationEnum'
default: HEADER_RIGHT
description: 'Where the search bar is located for classic pages. The in-place-of-header option requires federated search to be enabled for the domain.
* `HEADER_RIGHT` - Display search box in the header.
* `LEFT_NAV_TOP` - Display search box in the left nav.
* `HIDDEN` - Do not display search box.
* `IN_PLACE_OF_HEADER` - In place of HTML header'
search_behavior:
allOf:
- $ref: '#/components/schemas/SearchBehaviorEnum'
default: GLOBAL
description: 'Behavior of search bar for classic pages. The federated and no-search options require federated search to be enabled for the domain.
* `GLOBAL` - Global: Search spans all visible catalog pages
* `LOCAL` - Local: Search is limited to the current page / container
* `FEDERATED` - Federated search
* `NONE` - No search'
item_layout:
allOf:
- $ref: '#/components/schemas/ItemLayoutEnum'
default: TILE
description: 'Layout of items for classic pages.
* `TILE` - Tile view: Catalog items are displayed as tiles.
* `LIST` - List view: Catalog items are displayed full-width, one per line.'
SearchBehaviorEnum:
enum:
- GLOBAL
- LOCAL
- FEDERATED
- NONE
type: string
description: '* `GLOBAL` - Global: Search spans all visible catalog pages
* `LOCAL` - Local: Search is limited to the current page / container
* `FEDERATED` - Federated search
* `NONE` - No search'
PatchedCatalogPageRequest:
type: object
properties:
page_title:
type: string
minLength: 1
description: Title of the catalog page
slug:
type: string
minLength: 1
description: URL slug of the catalog page.
pattern: ^[-a-zA-Z0-9_]+$
short_description:
type: string
minLength: 1
description: Short description of the catalog page.
maxLength: 300
tile_callout:
type: string
minLength: 1
description: Tile callout text for the catalog page when embedded on another catalog page.
maxLength: 15
hidden:
type: boolean
default: false
description: Whether the catalog page is hidden by default.
strict_enforce_group_visibility:
type: boolean
default: false
description: Whether to strictly enforce group visibility.
header_html:
type: string
minLength: 1
description: HTML page header for classic pages.
tile_sort_method:
allOf:
- $ref: '#/components/schemas/TileSortMethodEnum'
default: catalog_settings_order
description: 'Tile sort method for classic pages.
* `catalog_settings_order` - Default Catalog Settings Ordering
* `registered_first_completed_last_order` - Registered, Unregistered, then Completed Courses
* `alphabetically_a_to_z` - Sort alphabetically A to Z
* `alphabetically_z_to_a` - Sort alphabetically Z to A'
search_location:
allOf:
- $ref: '#/components/schemas/SearchLocationEnum'
default: HEADER_RIGHT
description: 'Where the search bar is located for classic pages. The in-place-of-header option requires federated search to be enabled for the domain.
* `HEADER_RIGHT` - Display search box in the header.
* `LEFT_NAV_TOP` - Display search box in the left nav.
* `HIDDEN` - Do not display search box.
* `IN_PLACE_OF_HEADER` - In place of HTML header'
search_behavior:
allOf:
- $ref: '#/components/schemas/SearchBehaviorEnum'
default: GLOBAL
description: 'Behavior of search bar for classic pages. The federated and no-search options require federated search to be enabled for the domain.
* `GLOBAL` - Global: Search spans all visible catalog pages
* `LOCAL` - Local: Search is limited to the current page / container
* `FEDERATED` - Federated search
* `NONE` - No search'
item_layout:
allOf:
- $ref: '#/components/schemas/ItemLayoutEnum'
default: TILE
description: 'Layout of items for classic pages.
* `TILE` - Tile view: Catalog items are displayed as tiles.
* `LIST` - List view: Catalog items are displayed full-width, one per line.'
CatalogPageCreate:
type: object
description: Serializer for creating catalog pages in api only
properties:
id:
type: string
readOnly: true
page_title:
type: string
description: Title of the catalog page
slug:
type: string
description: URL slug of the catalog page.
pattern: ^[-a-zA-Z0-9_]+$
short_description:
type: string
description: Short description of the catalog page.
maxLength: 300
tile_callout:
type: string
description: Tile callout text for the catalog page when embedded on another catalog page.
maxLength: 15
hidden:
type: boolean
default: false
description: Whether the catalog page is hidden by default.
strict_enforce_group_visibility:
type: boolean
default: false
description: Whether to strictly enforce group visibility.
is_classic:
type: boolean
default: true
description: Whether the catalog page is classic, containing only course content, vs. a Builder page containing additional fields.
url:
type: string
description: Returns the URL of the catalog page.
readOnly: true
header_html:
type: string
description: HTML page header for classic pages.
tile_sort_method:
allOf:
- $ref: '#/components/schemas/TileSortMethodEnum'
default: catalog_settings_order
description: 'Tile sort method for classic pages.
* `catalog_settings_order` - Default Catalog Settings Ordering
* `registered_first_completed_last_order` - Registered, Unregistered, then Completed Courses
* `alphabetically_a_to_z` - Sort alphabetically A to Z
* `alphabetically_z_to_a` - Sort alphabetically Z to A'
search_location:
allOf:
- $ref: '#/components/schemas/SearchLocationEnum'
default: HEADER_RIGHT
description: 'Where the search bar is located for classic pages. The in-place-of-header option requires federated search to be enabled for the domain.
* `HEADER_RIGHT` - Display search box in the header.
* `LEFT_NAV_TOP` - Display search box in the left nav.
* `HIDDEN` - Do not display search box.
* `IN_PLACE_OF_HEADER` - In place of HTML header'
search_behavior:
allOf:
- $ref: '#/components/schemas/SearchBehaviorEnum'
default: GLOBAL
description: 'Behavior of search bar for classic pages. The federated and no-search options require federated search to be enabled for the domain.
* `GLOBAL` - Global: Search spans all visible catalog pages
* `LOCAL` - Local: Search is limited to the current page / container
* `FEDERATED` - Federated search
* `NONE` - No search'
item_layout:
allOf:
- $ref: '#/components/schemas/ItemLayoutEnum'
default: TILE
description: 'Layout of items for classic pages.
* `TILE` - Tile view: Catalog items are displayed as tiles.
* `LIST` - List view: Catalog items are displayed full-width, one per line.'
required:
- page_title
CatalogPageCreateRequest:
type: object
description: Serializer for creating catalog pages in api only
properties:
page_title:
type: string
minLength: 1
description: Title of the catalog page
slug:
type: string
minLength: 1
description: URL slug of the catalog page.
pattern: ^[-a-zA-Z0-9_]+$
short_description:
type: string
minLength: 1
description: Short description of the catalog page.
maxLength: 300
tile_callout:
type: string
minLength: 1
description: Tile callout text for the catalog page when embedded on another catalog page.
maxLength: 15
hidden:
type: boolean
default: false
description: Whether the catalog page is hidden by default.
strict_enforce_group_visibility:
type: boolean
default: false
description: Whether to strictly enforce group visibility.
is_classic:
type: boolean
default: true
description: Whether the catalog page is classic, containing only course content, vs. a Builder page containing additional fields.
header_html:
type: string
minLength: 1
description: HTML page header for classic pages.
tile_sort_method:
allOf:
- $ref: '#/components/schemas/TileSortMethodEnum'
default: catalog_settings_order
description: 'Tile sort method for classic pages.
* `catalog_settings_order` - Default Catalog Settings Ordering
* `registered_first_completed_last_order` - Registered, Unregistered, then Completed Courses
* `alphabetically_a_to_z` - Sort alphabetically A to Z
* `alphabetically_z_to_a` - Sort alphabetically Z to A'
search_location:
allOf:
- $ref: '#/components/schemas/SearchLocationEnum'
default: HEADER_RIGHT
description: 'Where the search bar is located for classic pages. The in-place-of-header option requires federated search to be enabled for the domain.
* `HEADER_RIGHT` - Display search box in the header.
* `LEFT_NAV_TOP` - Display search box in the left nav.
* `HIDDEN` - Do not display search box.
* `IN_PLACE_OF_HEADER` - In place of HTML header'
search_behavior:
allOf:
- $ref: '#/components/schemas/SearchBehaviorEnum'
default: GLOBAL
description: 'Behavior of search bar for classic pages. The federated and no-search options require federated search to be enabled for the domain.
* `GLOBAL` - Global: Search spans all visible catalog pages
* `LOCAL` - Local: Search is limited to the current page / container
* `FEDERATED` - Federated search
* `NONE` - No search'
item_layout:
allOf:
- $ref: '#/components/schemas/ItemLayoutEnum'
default: TILE
description: 'Layout of items for classic pages.
* `TILE` - Tile view: Catalog items are displayed as tiles.
* `LIST` - List view: Catalog items are displayed full-width, one per line.'
required:
- page_title
CatalogPageRequest:
type: object
properties:
page_title:
type: string
minLength: 1
description: Title of the catalog page
slug:
type: string
minLength: 1
description: URL slug of the catalog page.
pattern: ^[-a-zA-Z0-9_]+$
short_description:
type: string
minLength: 1
description: Short description of the catalog page.
maxLength: 300
tile_callout:
type: string
minLength: 1
description: Tile callout text for the catalog page when embedded on another catalog page.
maxLength: 15
hidden:
type: boolean
default: false
description: Whether the catalog page is hidden by default.
strict_enforce_group_visibility:
type: boolean
default: false
description: Whether to strictly enforce group visibility.
header_html:
type: string
minLength: 1
description: HTML page header for classic pages.
tile_sort_method:
allOf:
- $ref: '#/components/schemas/TileSortMethodEnum'
default: catalog_settings_order
description: 'Tile sort method for classic pages.
* `catalog_settings_order` - Default Catalog Settings Ordering
* `registered_first_completed_last_order` - Registered, Unregistered, then Completed Courses
* `alphabetically_a_to_z` - Sort alphabetically A to Z
* `alphabetically_z_to_a` - Sort alphabetically Z to A'
search_location:
allOf:
- $ref: '#/components/schemas/SearchLocationEnum'
default: HEADER_RIGHT
description: 'Where the search bar is located for classic pages. The in-place-of-header option requires federated search to be enabled for the domain.
* `HEADER_RIGHT` - Display search box in the header.
* `LEFT_NAV_TOP` - Display search box in the left nav.
* `HIDDEN` - Do not display search box.
* `IN_PLACE_OF_HEADER` - In place of HTML header'
search_behavior:
allOf:
- $ref: '#/components/schemas/SearchBehaviorEnum'
default: GLOBAL
description: 'Behavior of search bar for classic pages. The federated and no-search options require federated search to be enabled for the domain.
* `GLOBAL` - Global: Search spans all visible catalog pages
* `LOCAL` - Local: Search is limited to the current page / container
* `FEDERATED` - Federated search
* `NONE` - No search'
item_layout:
allOf:
- $ref: '#/components/schemas/ItemLayoutEnum'
default: TILE
description: 'Layout of items for classic pages.
* `TILE` - Tile view: Catalog items are displayed as tiles.
* `LIST` - List view: Catalog items are displayed full-width, one per line.'
ItemLayoutEnum:
enum:
- TILE
- LIST
type: string
description: '* `TILE` - Tile view: Catalog items are displayed as tiles.
* `LIST` - List view: Catalog items are displayed full-width, one per line.'
SearchLocationEnum:
enum:
- HEADER_RIGHT
- LEFT_NAV_TOP
- HIDDEN
- IN_PLACE_OF_HEADER
type: string
description: '* `HEADER_RIGHT` - Display search box in the header.
* `LEFT_NAV_TOP` - Display search box in the left nav.
* `HIDDEN` - Do not display search box.
* `IN_PLACE_OF_HEADER` - In place of HTML header'
PaginatedCatalogPageList:
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/CatalogPage'
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