• Curricula
  • getGet an individual curriculum by ID.
  • getGet all available curricula for sale.
  • getGet curriculum group.
  • postGets multiple curriculum groups.
  • getGet all available curricula.

API docs by Redocly

Absorb Integration API (v2)

Download OpenAPI specification:Download

Curricula

Get an individual curriculum by ID.

Authorizations:

api_key

path Parameters

id required

string <guid> The ID of the curriculum.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

isPacingEnabled	boolean True if pacing is enabled, false otherwise.
curriculumGroupIds	Array of strings <guid> [ items <guid > ] A list of curriculum group IDs.
id	string <guid> The unique course identifier.
courseType	string The course's type (ex, OnlineCourse, InstructorLedCourse, CourseBundle, Curriculum).
name	string The course's name.
description	string The course's description. Supports HTML.
notes	string The course's notes.
externalId	string The course's external ID.
accessDate	string <date-time> The course's access date.
expireType	integer Enum: 0 1 2 The course's expiry type. Possible Enum Values: 0 = None 1 = Date 2 = Duration
	object The course's duration until expiry, if applicable.
expiryDate	string <date-time> The course's expiry date, if applicable.
activeStatus	integer Enum: 0 1 The course's status. Possible Enum Values: 0 = Active 1 = Inactive
tagIds	Array of strings <guid> [ items <guid > ] The course's list of tag IDs.
resourceIds	Array of strings <guid> [ items <guid > ] The course's list of resource IDs.
editorIds	Array of strings <guid> [ items <guid > ] The course's list of editor IDs.
	Array of objects (PriceResource) The course's list of prices.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] The course's list of competency definition IDs.
prerequisiteCourseIds	Array of strings <guid> [ items <guid > ] The course's list of prerequisite course IDs.
postEnrollmentCourseIds	Array of strings <guid> [ items <guid > ] The course's list of post enrollment course IDs.
allowCourseEvaluation	boolean True if the course allows evaluation, false otherwise.
categoryId	string <guid> The course's category ID.
certificateUrl	string The course's certificate URL, if any.
audience	string The course's audience.
goals	string The course's goals.
vendor	string The course's vendor.
companyCost	number <decimal> The course's company cost.
learnerCost	number <decimal> The course's learner cost.
companyTime	number <decimal> The course's amount of company time.
learnerTime	number <decimal> The course's amount of learner time.
dateEdited	string <date-time> The course's last edited date.
dateAdded	string <date-time> The date the course was added.

US

https://rest.myabsorb.com/curriculums/{id}

CA

https://rest.myabsorb.ca/curriculums/{id}

EU

https://rest.myabsorb.eu/curriculums/{id}

AU

https://rest.myabsorb.com.au/curriculums/{id}

Response samples

• 200
• 404

Content type

application/json

{

• "isPacingEnabled": true,
• "curriculumGroupIds": [

  • "string"

  ],
• "id": "string",
• "courseType": "string",
• "name": "string",
• "description": "string",
• "notes": "string",
• "externalId": "string",
• "accessDate": "2019-08-24T14:15:22Z",
• "expireType": 0,
• "expireDuration": {

  • "years": 0,
  • "months": 0,
  • "days": 0,
  • "hours": 0

  },
• "expiryDate": "2019-08-24T14:15:22Z",
• "activeStatus": 0,
• "tagIds": [

  • "string"

  ],
• "resourceIds": [

  • "string"

  ],
• "editorIds": [

  • "string"

  ],
• "prices": [

  • {

    • "id": "string",
    • "departmentId": "string",
    • "currency": "string",
    • "amount": 0

    }

  ],
• "competencyDefinitionIds": [

  • "string"

  ],
• "prerequisiteCourseIds": [

  • "string"

  ],
• "postEnrollmentCourseIds": [

  • "string"

  ],
• "allowCourseEvaluation": true,
• "categoryId": "string",
• "certificateUrl": "string",
• "audience": "string",
• "goals": "string",
• "vendor": "string",
• "companyCost": 0,
• "learnerCost": 0,
• "companyTime": 0,
• "learnerTime": 0,
• "dateEdited": "2019-08-24T14:15:22Z",
• "dateAdded": "2019-08-24T14:15:22Z"

}

Get all available curricula for sale.

Authorizations:

api_key

query Parameters

id	string <guid> The curriculum id to filter by.
catId	string <guid> The curriculum category id to filter by.
from	string <date-time> The curriculum start date to filter by.
to	string <date-time> The curriculum end date to filter by.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

Array

isPacingEnabled	boolean True if pacing is enabled, false otherwise.
curriculumGroupIds	Array of strings <guid> [ items <guid > ] A list of curriculum group IDs.
id	string <guid> The unique course identifier.
courseType	string The course's type (ex, OnlineCourse, InstructorLedCourse, CourseBundle, Curriculum).
name	string The course's name.
description	string The course's description. Supports HTML.
notes	string The course's notes.
externalId	string The course's external ID.
accessDate	string <date-time> The course's access date.
expireType	integer Enum: 0 1 2 The course's expiry type. Possible Enum Values: 0 = None 1 = Date 2 = Duration
	object The course's duration until expiry, if applicable.
expiryDate	string <date-time> The course's expiry date, if applicable.
activeStatus	integer Enum: 0 1 The course's status. Possible Enum Values: 0 = Active 1 = Inactive
tagIds	Array of strings <guid> [ items <guid > ] The course's list of tag IDs.
resourceIds	Array of strings <guid> [ items <guid > ] The course's list of resource IDs.
editorIds	Array of strings <guid> [ items <guid > ] The course's list of editor IDs.
	Array of objects (PriceResource) The course's list of prices.
competencyDefinitionIds	Array of strings <guid> [ items <guid > ] The course's list of competency definition IDs.
prerequisiteCourseIds	Array of strings <guid> [ items <guid > ] The course's list of prerequisite course IDs.
postEnrollmentCourseIds	Array of strings <guid> [ items <guid > ] The course's list of post enrollment course IDs.
allowCourseEvaluation	boolean True if the course allows evaluation, false otherwise.
categoryId	string <guid> The course's category ID.
certificateUrl	string The course's certificate URL, if any.
audience	string The course's audience.
goals	string The course's goals.
vendor	string The course's vendor.
companyCost	number <decimal> The course's company cost.
learnerCost	number <decimal> The course's learner cost.
companyTime	number <decimal> The course's amount of company time.
learnerTime	number <decimal> The course's amount of learner time.
dateEdited	string <date-time> The course's last edited date.
dateAdded	string <date-time> The date the course was added.

US

https://rest.myabsorb.com/curriculums/for-sale

CA

https://rest.myabsorb.ca/curriculums/for-sale

EU

https://rest.myabsorb.eu/curriculums/for-sale

AU

https://rest.myabsorb.com.au/curriculums/for-sale

Response samples

• 200

Content type

application/json

[

• {

  • "isPacingEnabled": true,
  • "curriculumGroupIds": [

    • "string"

    ],
  • "id": "string",
  • "courseType": "string",
  • "name": "string",
  • "description": "string",
  • "notes": "string",
  • "externalId": "string",
  • "accessDate": "2019-08-24T14:15:22Z",
  • "expireType": 0,
  • "expireDuration": {

    • "years": 0,
    • "months": 0,
    • "days": 0,
    • "hours": 0

    },
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "activeStatus": 0,
  • "tagIds": [

    • "string"

    ],
  • "resourceIds": [

    • "string"

    ],
  • "editorIds": [

    • "string"

    ],
  • "prices": [

    • {

      • "id": "string",
      • "departmentId": "string",
      • "currency": "string",
      • "amount": 0

      }

    ],
  • "competencyDefinitionIds": [

    • "string"

    ],
  • "prerequisiteCourseIds": [

    • "string"

    ],
  • "postEnrollmentCourseIds": [

    • "string"

    ],
  • "allowCourseEvaluation": true,
  • "categoryId": "string",
  • "certificateUrl": "string",
  • "audience": "string",
  • "goals": "string",
  • "vendor": "string",
  • "companyCost": 0,
  • "learnerCost": 0,
  • "companyTime": 0,
  • "learnerTime": 0,
  • "dateEdited": "2019-08-24T14:15:22Z",
  • "dateAdded": "2019-08-24T14:15:22Z"

  }

]

Get curriculum group.

Authorizations:

api_key

query Parameters

id	string <guid> The ID of the curriculum.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> Identifier of curriculum group.
name	string Name of curriculum group.
order	integer <int32> Order of curriculum group within curriculum.
requiredNumberOfCourses	integer <int32> Required number of courses to complete the group.
curriculumId	string <guid> Identifier of curriculum this group belongs to.
	Array of objects (CurriculumGroupCourseResource) Courses in the group.

US

https://rest.myabsorb.com/curriculums/curriculum-group

CA

https://rest.myabsorb.ca/curriculums/curriculum-group

EU

https://rest.myabsorb.eu/curriculums/curriculum-group

AU

https://rest.myabsorb.com.au/curriculums/curriculum-group

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "name": "string",
• "order": 0,
• "requiredNumberOfCourses": 0,
• "curriculumId": "string",
• "courses": [

  • {

    • "id": "string",
    • "order": 0,
    • "courseType": "string"

    }

  ]

}

Gets multiple curriculum groups.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

Request containing identifiers of the curriculum groups.

groupIds

Array of strings <guid> [ items <guid > ] Identifiers of curriculum groups.

Responses

Response Schema: application/json

additional property	object (CurriculumGroupResource) Resource representing a curriculum group.
id string <guid> Identifier of curriculum group. name string Name of curriculum group. order integer <int32> Order of curriculum group within curriculum. requiredNumberOfCourses integer <int32> Required number of courses to complete the group. curriculumId string <guid> Identifier of curriculum this group belongs to. Array of objects (CurriculumGroupCourseResource) Courses in the group.

US

https://rest.myabsorb.com/curriculums/multiple-curriculum-groups

CA

https://rest.myabsorb.ca/curriculums/multiple-curriculum-groups

EU

https://rest.myabsorb.eu/curriculums/multiple-curriculum-groups

AU

https://rest.myabsorb.com.au/curriculums/multiple-curriculum-groups

Request samples

• Payload

Content type

application/json

{

• "groupIds": [

  • "string"

  ]

}

Response samples

• 200
• 400

Content type

application/json

{

• "property1": {

  • "id": "string",
  • "name": "string",
  • "order": 0,
  • "requiredNumberOfCourses": 0,
  • "curriculumId": "string",
  • "courses": [

    • {

      • "id": "string",
      • "order": 0,
      • "courseType": "string"

      }

    ]

  },
• "property2": {

  • "id": "string",
  • "name": "string",
  • "order": 0,
  • "requiredNumberOfCourses": 0,
  • "curriculumId": "string",
  • "courses": [

    • {

      • "id": "string",
      • "order": 0,
      • "courseType": "string"

      }

    ]

  }

}

Get all available curricula.

Authorizations:

api_key

query Parameters

_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=firstname eq 'Jeffrey' _filter=id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22' _filter=startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with -. For example, _sort=name,-date, sorts the collection of items by name (ascending) and then by date (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

totalItems	integer <int32> The total number of items in the unbounded collection
returnedItems	integer <int32> The number of items in the bound collection being returned
limit	integer <int32> The current page size for the collection
offset	integer <int32> The current offset for the collection
	Array of objects (CurriculumResource) The paged collection of resources.

US

https://rest.myabsorb.com/curriculums

CA

https://rest.myabsorb.ca/curriculums

EU

https://rest.myabsorb.eu/curriculums

AU

https://rest.myabsorb.com.au/curriculums

Response samples

• 200
• 422

Content type

application/json

{

• "totalItems": 0,
• "returnedItems": 0,
• "limit": 0,
• "offset": 0,
• "curriculums": [

  • {

    • "id": "string",
    • "courseType": "string",
    • "name": "string",
    • "description": "string",
    • "notes": "string",
    • "externalId": "string",
    • "accessDate": "2019-08-24T14:15:22Z",
    • "expireType": 0,
    • "expireDuration": {

      • "years": 0,
      • "months": 0,
      • "days": 0,
      • "hours": 0

      },
    • "expiryDate": "2019-08-24T14:15:22Z",
    • "activeStatus": 0,
    • "tagIds": [

      • "string"

      ],
    • "resourceIds": [

      • "string"

      ],
    • "editorIds": [

      • "string"

      ],
    • "prices": [

      • {

        • "id": "string",
        • "departmentId": "string",
        • "currency": "string",
        • "amount": 0

        }

      ],
    • "competencyDefinitionIds": [

      • "string"

      ],
    • "prerequisiteCourseIds": [

      • "string"

      ],
    • "postEnrollmentCourseIds": [

      • "string"

      ],
    • "allowCourseEvaluation": true,
    • "categoryId": "string",
    • "certificateUrl": "string",
    • "audience": "string",
    • "goals": "string",
    • "vendor": "string",
    • "companyCost": 0,
    • "learnerCost": 0,
    • "companyTime": 0,
    • "learnerTime": 0,
    • "dateEdited": "2019-08-24T14:15:22Z",
    • "dateAdded": "2019-08-24T14:15:22Z",
    • "isPacingEnabled": true,
    • "curriculumGroupIds": [

      • "string"

      ]

    }

  ]

}