Log in
Discover content locally via API

Displaying the GO1 content within the partner application is the most seamless solution for content discovery, as it allows customers to search and interact with the GO1 content in a familiar setting.

A common way to surface GO1 content is by building a training library or catalog, where customers can browse, search for, or filter content they are interested in.

In the GO1 database, each piece of content is represented as a Learning object (often abbreviated to LO), and consists of the following metadata items:

  • LO-ID - an integer which acts as the unique identifier for the learning object
  • Title - the learning object title
  • Description - the learning object description
  • Provider - the content provider for this learning object (e.g. SkillSoft)
  • Image - a thumbnail image provided by the content provider (often used to create a course)
  • Duration - approximate duration of the learning object in seconds

Our API provides a simple solution to retrieve and interact with learning objects and their associated metadata.

By making a GET request to the learning objects endpoint, and including a series of query parameters, you will have the ability to perform the following common use cases:

  • List learning objects - retrieve a list of content available to the portal, along with the associated metadata
  • Search for learning objects - use a keyword search to return a list of relevant content
  • Filter learning objects - use a filter (e.g. provider, topics, tags, duration) to return a more refined list of content
When it works
  • When a partner has already configured access to GO1 API
  • When a partner has their own Learning Management or Training interface
  • When a partner wants to contain the user experience within the partner application
When it doesn't work
  • When development resources are limited
Requirements
Often used with
Alternatives
API Documentation
Step 1

Follow the steps on our Authentication and authorization guide to retrieve an access token.

Step 2

To retrieve a list of GO1 content, your application will be required to make a GET request to the GO1 learning objects endpoint.
The GET request is made to https://api.go1.com/v2/learning-objects

curl --request GET \
  --url https://api.go1.com/v2/learning-objects \
  --header 'Authorization: Bearer ACCESS_TOKEN'

GO1 returns with a list of learning objects, including the associated metadata for each returned LO. Below is an example of a single learning object returned

{
    "total": 58016,
    "hits": [
		{
		    "id": LO ID,
		    "type": "LO TYPE (EG. COURSE)",
		    "title": "LO TITLE",
		    "image": "LO IMAGE URL",
		    "language": "en",
		    "description": "LO DESCRIPTION",
		    "created_time": "2019-03-16T09:28:21+00:00",
		    "updated_time": "2020-02-06T02:47:25+00:00",
		    "summary": "",
		    "assessable": true,
		    "collections": [],
		    "portal_collection": false,
		    "delivery": {
		        "duration": 12,
		        "mode": "self-paced"
		    },
		    "previewable": false,
		    "pricing": {
		        "currency": "AUD",
		        "price": 0,
		        "tax": 0,
		        "tax_included": true
		    },
		    "provider": {
		        "id": PROVIDER ID,
		        "logo": "PROVIDER LOGO IMAGE URL",
		        "name": "PROVIDER NAME"
		    },
		    "subscription": {
		        "licenses": -1,
		        "package": "premium"
		    },
		    "tags": [
		        "Writing",
		        "Creative Inspiration",
		        "Communication Skills"
		    ],
		    "attributes": {
					//other attributes of the Learning Object, such as topics, regional relevance, mobile compatibility, etc. 
		    }
		}
}

The opening line of this response includes a 'total hits' register, e.g. "total": 58016, which denotes the total number of learning objects associated with the request made. In relation to the example above, where an empty request to the learning objects endpoint with no additional query parameters was made, the total hits returned is the total number of learning objects associated with the portal.

Since the returned data can be quite large e.g. 58,000+ objects, GO1 limits the default number of returned learning objects to a total of 20.

Limit

To increase or reduce the number of returned objects, include limit as a query parameter

curl --request GET \
  --url https://api.go1.com/v2/learning-objects?limit=50 \
  --header 'Authorization: Bearer ACCESS_TOKEN'

The limit value passed will determine the number of returned hits (up to a maximum of 50).

Offset (pagination)

To return the next set of learning objects results after the initial limit (ie. default of 20 LO's returned), include the offset parameter:

curl --request GET \
  --url https://api.go1.com/v2/learning-objects?limit=50&offset=50 \
  --header 'Authorization: Bearer ACCESS_TOKEN'

The offset value passed will determine where to start paging the next set of results from the greater list of learning objects returned. To take the above request as an example, where offset=50 and limit=50, the returned results will include the 50th through to 100th learning objects.

Keyword

To search the GO1 content library, include the keyword query parameter, to return a list of GO1 content relevant to your specific keyword search

curl --request GET \
  --url https://api.go1.com/v2/learning-objects?keyword=leadership \
  --header 'Authorization: Bearer ACCESS_TOKEN'

The keyword value passed will query the list of learning objects in the GO1 database, and display the most relevant objects based on the keyword.

© Copyright 2020 · All Rights Reserved