Skilljar Domains > Access Codes > Pools API
The Domains > Access Codes > Pools API from Skilljar — 2 operation(s) for domains > access codes > pools.
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-domains-access-codes-pools-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 > Access Codes > 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: Domains > Access Codes > Pools
paths:
/v1/domains/{domain_name}/access-code-pools:
get:
operationId: domains_access_code_pools_list
description: 'List access code pools.
Retrieve a paginated list of access code pools for a domain.
Pools can be filtered by name using the `name` query parameter.'
parameters:
- in: path
name: domain_name
schema:
type: string
pattern: ^[-:\.0-9a-z]+$
required: true
- in: query
name: name
schema:
type: string
description: Filter returned access code pools by name
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
tags:
- Domains > Access Codes > Pools
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedDomainAccessCodePoolListItemList'
description: ''
summary: Domains access code pools list
x-summary-source: derived
post:
operationId: domains_access_code_pools_create
description: 'Create an access code pool.
Create a new, empty pool of access codes for the specified domain.
The pool can be used to manage and distribute access codes to learners.'
parameters:
- in: path
name: domain_name
schema:
type: string
pattern: ^[-:\.0-9a-z]+$
required: true
tags:
- Domains > Access Codes > Pools
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainAccessCodePoolDetailRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DomainAccessCodePoolDetailRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DomainAccessCodePoolDetailRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DomainAccessCodePoolDetail'
description: ''
summary: Domains access code pools create
x-summary-source: derived
/v1/domains/{domain_name}/access-code-pools/{access_code_pool_id}:
get:
operationId: domains_access_code_pools_retrieve
description: 'Retrieve an access code pool.
Get details for a specific access code pool, including its name, status, validity period, and code count.'
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 > Pools
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DomainAccessCodePoolDetail'
description: ''
summary: Domains access code pools retrieve
x-summary-source: derived
put:
operationId: domains_access_code_pools_update
description: 'Update an access code pool.
Update the properties of an existing access code pool. Both PUT and PATCH requests are supported.'
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 > Pools
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DomainAccessCodePoolDetailRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/DomainAccessCodePoolDetailRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/DomainAccessCodePoolDetailRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DomainAccessCodePoolDetail'
description: ''
summary: Domains access code pools update
x-summary-source: derived
patch:
operationId: domains_access_code_pools_partial_update
description: 'Update an access code pool.
Update the properties of an existing access code pool. Both PUT and PATCH requests are supported.'
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 > Pools
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedDomainAccessCodePoolDetailRequest'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedDomainAccessCodePoolDetailRequest'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedDomainAccessCodePoolDetailRequest'
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DomainAccessCodePoolDetail'
description: ''
summary: Domains access code pools partial update
x-summary-source: derived
delete:
operationId: domains_access_code_pools_destroy
description: 'Delete an access code pool.
Permanently delete an access code pool and all access codes it contains.'
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 > Pools
security:
- OrganizationApiKey: []
- tokenAuth: []
responses:
'204':
description: No response body
summary: Domains access code pools destroy
x-summary-source: derived
components:
schemas:
PatchedDomainAccessCodePoolDetailRequest:
type: object
properties:
name:
type: string
minLength: 1
description: Name of the access code pool. This may have been auto-generated when creating individual codes in the dashboard.
maxLength: 255
active:
type: boolean
default: true
start_date:
type:
- string
- 'null'
format: date-time
end_date:
type:
- string
- 'null'
format: date-time
expire_linked_to_domain_membership:
type: boolean
description: When this is true and an end_date is set, a user who registers with a code from this pool will lose access to the domain on the end_date.
DomainAccessCodePoolDetail:
type: object
properties:
id:
type: string
readOnly: true
name:
type: string
description: Name of the access code pool. This may have been auto-generated when creating individual codes in the dashboard.
maxLength: 255
active:
type: boolean
default: true
start_date:
type:
- string
- 'null'
format: date-time
end_date:
type:
- string
- 'null'
format: date-time
expire_linked_to_domain_membership:
type: boolean
description: When this is true and an end_date is set, a user who registers with a code from this pool will lose access to the domain on the end_date.
channel:
readOnly: true
oneOf:
- $ref: '#/components/schemas/ChannelEnum'
- $ref: '#/components/schemas/NullEnum'
code_count:
type: integer
readOnly: true
PaginatedDomainAccessCodePoolListItemList:
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/DomainAccessCodePoolListItem'
DomainAccessCodePoolDetailRequest:
type: object
properties:
name:
type: string
minLength: 1
description: Name of the access code pool. This may have been auto-generated when creating individual codes in the dashboard.
maxLength: 255
active:
type: boolean
default: true
start_date:
type:
- string
- 'null'
format: date-time
end_date:
type:
- string
- 'null'
format: date-time
expire_linked_to_domain_membership:
type: boolean
description: When this is true and an end_date is set, a user who registers with a code from this pool will lose access to the domain on the end_date.
ChannelEnum:
enum:
- api
- import
- dashboard
- ecommerce
- unknown
type: string
description: '* `api` - API
* `import` - Import
* `dashboard` - Dashboard
* `ecommerce` - E-Commerce
* `unknown` - Unknown'
DomainAccessCodePoolListItem:
type: object
properties:
id:
type: string
readOnly: true
name:
type: string
description: Name of the access code pool. This may have been auto-generated when creating individual codes in the dashboard.
maxLength: 255
active:
type: boolean
default: true
start_date:
type:
- string
- 'null'
format: date-time
end_date:
type:
- string
- 'null'
format: date-time
expire_linked_to_domain_membership:
type: boolean
description: When this is true and an end_date is set, a user who registers with a code from this pool will lose access to the domain on the end_date.
channel:
readOnly: true
oneOf:
- $ref: '#/components/schemas/ChannelEnum'
- $ref: '#/components/schemas/NullEnum'
NullEnum:
enum:
- null
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