Download OpenAPI specification:
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
Returns list of assigned asset progress per path and user for account.
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 |
{- "assigned": [
- {
- "learner_id": "226d226d-226d-226d-226d-226d534c87c8",
- "sso_id": "string",
- "learning_path_id": 19,
- "learning_path_name": "ISACA CRISC",
- "percent_complete": 0.1,
- "date_assigned": "2021-02-23T19:42:47+00:00",
- "date_started": "2021-02-23T19:42:47+00:00",
- "date_completed": "2019-08-24T14:15:22Z",
- "is_custom": true,
- "modified": "2021-02-23T19:42:47+00:00"
}
], - "page": 1,
- "pageCount": 1
}
This endpoint retrieves a list of the learners on your account.
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 |
{- "data": {
- "learner_id": "226d226d-226d-226d-226d-226d534c87c8",
- "sso_id": "string",
- "email": "user@example.com",
- "first_name": "string",
- "last_name": "string",
- "department": "string",
- "status": "active",
- "created": "2019-09-26T13:35:59+00:00",
- "modified": "2021-03-25T00:50:20+00:00"
}, - "page": 1,
- "pageCount": 1
}
This endpoint retrieves a list of the learning paths in progress for the users on your account.
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 |
{- "data": {
- "learner_id": "226d226d-226d-226d-226d-226d534c87c8",
- "sso_id": "string",
- "learning_path_id": 19,
- "learning_path_name": "ISACA CRISC",
- "percent_complete": 0.1,
- "date_started": "2021-02-23T19:42:47+00:00",
- "date_completed": "2019-08-24T14:15:22Z",
- "is_custom": true,
- "modified": "2021-02-23T19:42:47+00:00"
}, - "page": 1,
- "pageCount": 1
}
Returns identified boot camp properties.
id required | any Boot camp ID |
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 |
{- "bootcamp": {
- "id": "a0t0y000a0t0y000AU",
- "name": "CIPM Boot Camp",
- "description": "Infosec’s two-day authorized CIPM boot camp focuses on the development, implementation and management of privacy policies and frameworks",
- "keywords": "string",
- "schedules": [
- {
- "id": "a060y0a060y0URmAAO",
- "schedule_name": "CIPM Flex Classroom: 01/29/20-01/30/20 in Dulles",
- "bootcamp_id": "a0t0y000a0t0y000AU",
- "city": "Dulles",
- "province": "Virginia",
- "online": true,
- "in_person": true,
- "start_date": "2020-01-29",
- "end_date": "2020-01-30",
- "start_time": "01:30:00",
- "created": "2020-01-07T18:06:53+00:00",
- "modified": "2020-01-07T18:06:53+00:00"
}
], - "created": "2019-09-06T20:47:34+00:00",
- "modified": "2020-10-02T15:50:55+00:00"
}
}
Returns a list of Skills boot camps.
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 |
{- "bootcamps": [
- {
- "id": "a0t0y000a0t0y000AU",
- "name": "CIPM Boot Camp",
- "description": "Infosec’s two-day authorized CIPM boot camp focuses on the development, implementation and management of privacy policies and frameworks",
- "keywords": "string",
- "schedules": [
- {
- "id": "a060y0a060y0URmAAO",
- "schedule_name": "CIPM Flex Classroom: 01/29/20-01/30/20 in Dulles",
- "bootcamp_id": "a0t0y000a0t0y000AU",
- "city": "Dulles",
- "province": "Virginia",
- "online": true,
- "in_person": true,
- "start_date": "2020-01-29",
- "end_date": "2020-01-30",
- "start_time": "01:30:00",
- "created": "2020-01-07T18:06:53+00:00",
- "modified": "2020-01-07T18:06:53+00:00"
}
], - "created": "2019-09-06T20:47:34+00:00",
- "modified": "2020-10-02T15:50:55+00:00"
}
], - "page": 1,
- "pageCount": 1
}
Returns identified boot camp schedule properties.
id required | any Schedule ID |
{- "schedule": {
- "id": "a060y0a060y0URmAAO",
- "schedule_name": "CIPM Flex Classroom: 01/29/20-01/30/20 in Dulles",
- "bootcamp_id": "a0t0y000a0t0y000AU",
- "city": "Dulles",
- "province": "Virginia",
- "online": true,
- "in_person": true,
- "start_date": "2020-01-29",
- "end_date": "2020-01-30",
- "start_time": "01:30:00",
- "created": "2020-01-07T18:06:53+00:00",
- "modified": "2020-01-07T18:06:53+00:00"
}
}
Returns a list of boot camp schedules.
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 |
{- "schedules": [
- {
- "id": "a060y0a060y0URmAAO",
- "schedule_name": "CIPM Flex Classroom: 01/29/20-01/30/20 in Dulles",
- "bootcamp_id": "a0t0y000a0t0y000AU",
- "city": "Dulles",
- "province": "Virginia",
- "online": true,
- "in_person": true,
- "start_date": "2020-01-29",
- "end_date": "2020-01-30",
- "start_time": "01:30:00",
- "created": "2020-01-07T18:06:53+00:00",
- "modified": "2020-01-07T18:06:53+00:00"
}
], - "page": 1,
- "pageCount": 1
}
{- "course": {
- "id": 1,
- "name": "Implementation of Security Controls",
- "description": "Get ready to implement security controls with this course covering applying, implementing and tailoring controls. Includes vocabulary and diagrams.",
- "time_estimate": 60,
- "keywords": "string",
- "created": "2019-06-24T15:06:25+00:00",
- "modified": "2020-07-16T18:53:11+00:00"
}
}
Returns a list of Skills courses for account.
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 |
{- "courses": [
- {
- "id": 1,
- "name": "Implementation of Security Controls",
- "description": "Get ready to implement security controls with this course covering applying, implementing and tailoring controls. Includes vocabulary and diagrams.",
- "time_estimate": 60,
- "keywords": "string",
- "created": "2019-06-24T15:06:25+00:00",
- "modified": "2020-07-16T18:53:11+00:00"
}
], - "page": 1,
- "pageCount": 1
}
Returns identified Skills Team learning path properties.
id required | any Learning path ID |
{- "path": {
- "id": 10,
- "name": "ISACA CRISC",
- "description": "The Certified in Risk and Information Systems Control (CRISC) certification path teaches you how to design, implement, monitor and maintain risk-based, efficient and effective IS controls.",
- "type": "public",
- "learning_scope": "certification",
- "time_estimate": 684,
- "keywords": "string",
- "created": "2019-02-27T18:21:17+00:00",
- "modified": "2021-03-24T17:36:09+00:00"
}
}
Returns list of public and custom Skills Team learning paths for account.
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 |
{- "paths": [
- {
- "id": 10,
- "name": "ISACA CRISC",
- "description": "The Certified in Risk and Information Systems Control (CRISC) certification path teaches you how to design, implement, monitor and maintain risk-based, efficient and effective IS controls.",
- "type": "public",
- "learning_scope": "certification",
- "time_estimate": 684,
- "keywords": "string",
- "created": "2019-02-27T18:21:17+00:00",
- "modified": "2021-03-24T17:36:09+00:00"
}
], - "page": 1,
- "pageCount": 1
}