Skills Public API (1.0)

Download OpenAPI specification:Download

Welcome to the Skills REST API documentation!

The API endpoints documented here should be prefixed with /portal/api/v1 when called.
Example: https://app.infosecinstitute.com/portal/api/v1/bootcamps

Authentication

API Token

API calls require an API token. Generate an API Token through your Skills account API settings page.

Security Scheme Type: API Key
Header parameter name: Authorization

Learner Information

List assigned content

Returns list of assigned asset progress per path and user for account.

query Parameters
start
date (start)
Example: start=2021-12-09 13:55:05

YYYY-MM-DD HH:MM:SS format. Retrieve assigned content records modified on or after this timestamp. Using this sorts results by modified date

page
integer (page) >= 1
Default: 1

Which page of results to return

limit
integer (limit) [ 1 .. 500 ]
Default: 500

Number of results per page

Responses

Response samples

Content type
application/json
{
  • "assigned": [
    ],
  • "page": 1,
  • "pageCount": 1
}

List learners

This endpoint retrieves a list of the learners on your account.

query Parameters
start
date (start)
Example: start=2021-12-09 13:55:05

YYYY-MM-DD HH:MM:SS format. Retrieve learner records modified on or after this timestamp. Using this sorts results by modified date

page
integer (page) >= 1
Default: 1

Which page of results to return

limit
integer (limit) [ 1 .. 500 ]
Default: 500

Number of results to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "page": 1,
  • "pageCount": 1
}

Completion data for learners

This endpoint retrieves a list of the learning paths in progress for the users on your account.

query Parameters
learner_id
string <uuid> (learner_id)
Example: learner_id=226d226d-226d-226d-226d-226d534c87c8

Get completion data for a single learner

learning_path_id
integer (learning_path_id) >= 1

Get completion for a single learning path ID

is_complete
boolean (is_complete)

Get completion based on whether it is 100% completed by the user or not. If this parameter is not passed, both complete and incomplete records are returned

is_custom
boolean (is_custom)

Retrieve only learning paths that are custom paths. If this parameter is not passed, both custom and public paths are returned

start
date (start)
Example: start=2021-12-09 13:55:05

YYYY-MM-DD HH:MM:SS format. Retrieve learning path completion records modified on or after this timestamp. Results are sorted by modified date

page
integer (page) >= 1
Default: 1

Which page of results to return

limit
integer (limit) [ 1 .. 500 ]
Default: 500

Number of results to return

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "page": 1,
  • "pageCount": 1
}

Boot Camp Content

Show boot camp

Returns identified boot camp properties.

path Parameters
id
required
any

Boot camp ID

query Parameters
include
string (include)
Example: include=schedules

Optional. 'include=schedules' adds boot camp schedule information to results

start_date
string (start_date)
Example: start_date=2021-05-01

YYYY-MM-DD format. Optional. Used with 'include=schedules'. Specifies the beginning date of schedules to return. if not specified, tomorrow is the default date used. start_date can be in the future or up to one year in the past

Responses

Response samples

Content type
application/json
{}

List boot camps

Returns a list of Skills boot camps.

query Parameters
include
string (include)
Example: include=schedules

Optional. 'include=schedules' adds boot camp schedule information to results

start_date
string (start_date)
Example: start_date=2021-05-01

YYYY-MM-DD format. Optional. Used with 'include=schedules'. Specifies the beginning date of schedules to return. if not specified, tomorrow is the default date used. start_date can be in the future or up to one year in the past

start
date (start)
Example: start=2021-12-09 13:55:05

YYYY-MM-DD HH:MM:SS format. Retrieve boot camp records modified on or after this timestamp. This option is different than start_date. Using this also sorts results by modified date

page
integer (page) >= 1
Default: 1

Which page of results to return

limit
integer (limit) [ 1 .. 500 ]
Default: 500

Number of results per page

Responses

Response samples

Content type
application/json
{}

Show boot camp schedule

Returns identified boot camp schedule properties.

path Parameters
id
required
any

Schedule ID

Responses

Response samples

Content type
application/json
{}

List boot camp schedules

Returns a list of boot camp schedules.

query Parameters
start_date
string (start_date)
Example: start_date=2021-05-01

YYYY-MM-DD format. Optional. Specifies the beginning date of schedules to return. if not specified, tomorrow is the default date used. start_date can be in the future or up to one year in the past

start
date (start)
Example: start=2021-12-09 13:55:05

YYYY-MM-DD HH:MM:SS format. Retrieve schedule records modified on or after this timestamp. This option is different than start_date. Using this also sorts results by modified date

page
integer (page) >= 1
Default: 1

Which page of results to return

limit
integer (limit) [ 1 .. 500 ]
Default: 500

Number of results per page

Responses

Response samples

Content type
application/json
{}

Catalog Content

Show course

Returns identified course properties.

path Parameters
id
required
any

Course ID

Responses

Response samples

Content type
application/json
{}

List courses

Returns a list of Skills courses for account.

query Parameters
start
date (start)
Example: start=2021-12-09 13:55:05

YYYY-MM-DD HH:MM:SS format. Retrieve course records modified on or after this timestamp. Using this also sorts results by modified date

page
integer (page) >= 1
Default: 1

Which page of results to return

limit
integer (limit) [ 1 .. 500 ]
Default: 500

Number of results per page

Responses

Response samples

Content type
application/json
{}

Show learning path

Returns identified Skills Team learning path properties.

path Parameters
id
required
any

Learning path ID

Responses

Response samples

Content type
application/json
{}

List learning paths

Returns list of public and custom Skills Team learning paths for account.

query Parameters
start
date (start)
Example: start=2021-12-09 13:55:05

YYYY-MM-DD HH:MM:SS format. Retrieve learning path records modified on or after this timestamp. Using this sorts results by modified date

page
integer (page) >= 1
Default: 1

Which page of results to return

limit
integer (limit) [ 1 .. 500 ]
Default: 500

Number of results per page

Responses

Response samples

Content type
application/json
{}