Suggest Edits

Authorization

 
 
 
Suggest Edits

Start OAuth2 authorization flow

This endpoint should be hit by the end user's browser. It will start the authentication and authorization flows.

 
gethttps://auth.go1.com/oauth/authorize

Query Params

client_id
string
required

Client ID of the application. If new_client is set, this can be any string that doesn't match an existing client_id.

response_type
string
required

The desired grant type.

redirect_uri
string
required

The URL to redirect to after the user authorizes your application. It must match your client redirect_uri.

redirect
boolean

If set to false, the user will not be redirected at the end of the flow, but instead the credentials will be presented on a new page.

Can only be used in conjunction with response_type=code.

scope
string

A list of space separated permissions that will be requested to the user.

state
string

A state string that'll be sent back to the redirect_uri.

new_client
string

When set it will create a new OAuth client if the given client_id doesn't exist. The value should be the client name. The generated client_id and client_secret will be appended to the redirect_uri as part of the query string or fragment parameters. Only letters, digits and punctuation characters are allowed.

creation_path
string

If set, the value must be a creation path for an existing preset.
Refer to presets in the #onboard2 service for possible values.

partner_portal_id
integer

If set, the value must be the ID of an existing distribution partner portal.

 
No code samples available
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Validate an access token offline

You can use this public key to validate an access token has been issued by this service. This is the preferred method as it can work offline provided you store the public key. Please make sure to respect the caching TTL and headers when doing so.

 
gethttps://auth.go1.com/oauth/public-key
 
No code samples available
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Retrieve an access token

It retrieves an access token for all grant types except implicit.

 
posthttps://auth.go1.com/oauth/token

Form Data

client_id
string
required

The application client id.

client_secret
string

The application client secret. Required, except if your application does not have one.

code
string

Required when grant_type is authorization_code. Do not pass otherwise.

refresh_token
string

Required when grant_type is refresh_token. Do not pass otherwise.

jwt
string

Required when grant_type is go1_jwt. Do not pass otherwise.

portal_name
string

Required when your application is public and you're using a go1_jwt or password grant_type. Do not pass otherwise.

grant_type
string
required
redirect_uri
string

The application redirect_uri. Required when grant_type is authorization_code. For security purposes it needs to match the one registered in the application.

 
No code samples available
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

Validate an access token

Checks whether the access token is valid and hasn't been revoked and returns back some information. You should only need to use it for debugging purposes or inside a resource server.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://auth.go1.com/oauth/validate
 
No code samples available
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

OAuth Client Management

 
 
 
Suggest Edits

Get a list of OAuth clients

Retrieves a list of OAuth client applications owned by the user, or associated with a specific portal. Only applications with special permissions are allowed to use this endpoint.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://auth.go1.com/client

Query Params

portal_name
string

When given it'll retrieve all OAuth clients registered to that portal. Omit for public clients.

offset
integer

Skip first N results

limit
integer

Return N results maximum. Defaults to 10, and must be <= 50

 
No code samples available
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Create a new OAuth client

Creates a new OAuth client application. Only applications with special permissions are allowed to use this endpoint.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://auth.go1.com/client

Form Data

portal_name
string

When provided it'll create a private client. Omit for public clients.

redirect_uri
string

The fully qualified URL that will be used to send responses in the authorization flow.

client_name
string

The OAuth client name. It'll be shown to the users when authenticating.

 
No code samples available
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Update OAuth client

Update OAuth client settings

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://auth.go1.com/client/clientId

Path Params

clientId
string
required

Client id

Form Data

status
integer

Client status. 0 = inactive, 1 = active

redirect_uri
string

The URL to redirect to after the user authorizes your application. It must match your client redirect_uri.

client_name
string

The client name. It'll be shown to the users when authenticating.

 
No code samples available
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Delete OAuth client

Delete client

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://auth.go1.com/client/clientId

Path Params

clientId
string
required

Client id

 
No code samples available
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Changes the client's secret

Generates a new random secret for the OAuth client. You need an application access token, thus obtained through client_credentials flow.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://auth.go1.com/client/clientId/regenerate-secret

Path Params

clientId
string
required

Client id

 
No code samples available
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
 
 
 
Suggest Edits

Get portal details

Detailed information about the portal the token is connected to. Including information about features activated and the billing plan.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/account
 
curl --request GET \
  --url https://api.go1.com/v2/account
var request = require("request");

var options = { method: 'GET', url: 'https://api.go1.com/v2/account' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/account")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/account");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/account"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Collections

 
 
 
Suggest Edits

Add items to a collection

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/collections/collection-id/items/add

Path Params

collection-id
string
required

The collection identifier number, or the string default.

Body Params

lo
array of integers
required

An array of learning object IDs to be added.

 
curl --request POST \
  --url https://api.go1.com/v2/collections/collection-id/items/add
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.go1.com/v2/collections/collection-id/items/add' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/collections/collection-id/items/add")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/collections/collection-id/items/add");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/collections/collection-id/items/add"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Remove items from a collection

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/collections/collection-id/items/remove

Path Params

collection-id
string
required

The collection identifier number, or the string default.

Body Params

lo
array of integers
required

An array of learning object IDs to be removed.

 
curl --request POST \
  --url https://api.go1.com/v2/collections/collection-id/items/remove
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.go1.com/v2/collections/collection-id/items/remove' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/collections/collection-id/items/remove")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/collections/collection-id/items/remove");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/collections/collection-id/items/remove"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Configuration

 
 
 
Suggest Edits

Get portal configuration

Gets the key value configuration pairs for a portal.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/configuration
 
curl --request GET \
  --url https://api.go1.com/v2/configuration
var request = require("request");

var options = { method: 'GET', url: 'https://api.go1.com/v2/configuration' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/configuration")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/configuration");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/configuration"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Modify portal configuration

Creates or updates the key value configuration pairs as sent in the request body.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
puthttps://api.go1.com/v2/configuration

Body Params

pay_per_seat
boolean
 
curl --request PUT \
  --url https://api.go1.com/v2/configuration
var request = require("request");

var options = { method: 'PUT', url: 'https://api.go1.com/v2/configuration' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/configuration")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.go1.com/v2/configuration");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/configuration"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Learning Content

 
 
 
Suggest Edits

Create a new link

Creates a new standalone link type learning item.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/content/links

Body Params

title
string
required

Link title.

url
string
required

A valid URL.

description
string
language
string

The language of the content to which the link points.

Accepts two-letter ISO 639-1 codes for languages in lowercase, and optionally two-letter ISO 3166-1 alpha-2 codes for countries in lowercase, separated by a hyphen.

Defaults to en if not specified.

 
curl --request POST \
  --url https://api.go1.com/v2/content/links
var request = require("request");

var options = { method: 'POST', url: 'https://api.go1.com/v2/content/links' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/content/links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/content/links");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/content/links"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Create a new manual learning item

Creates a new standalone manual type learning item.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/content/manual

Body Params

title
string
required

Manual title.

provider
string
required

The workshop provider

language
string

The language of the content to which the link points.

Accepts two-letter ISO 639-1 codes for languages in lowercase, and optionally two-letter ISO 3166-1 alpha-2 codes for countries in lowercase, separated by a hyphen.

Defaults to en if not specified.

 
curl --request POST \
  --url https://api.go1.com/v2/content/manual
var request = require("request");

var options = { method: 'POST', url: 'https://api.go1.com/v2/content/manual' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/content/manual")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/content/manual");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/content/manual"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

List learning objects

Search for learning objects.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/learning-objects

Query Params

offset
integer

Offset to start paging from. Offset + limit must not exceed 10,000.

limit
integer

Number of items to return. Maximum value is 50. Each endpoint has a default limit where applicable, so passing in
a value is recommended.

collection
string

Filter by collection.

content_group[]
array of integers

Filter by content group

event
string

Filter learning objects based on their events.

Available values:

  • true: Only return learning objects with events.
  • false: Only return learning objects without events.
  • all: Return learning objects both with and without events.
eventStartDate
number

Event start date in Unix timestamp format. Use to filter for learning objects with events starting at a specific time and date.

Example: 1531785600

eventEndDate
number

Event end date in Unix timestamp format. Use to filter for learning objects with events ending at a specific time and date.

Example: 1531872000

facets
string

Search facets to be returned.

Format: facets=facet[,facet...]

Examples

  • facets=language -- the response will include a facets object containing a language object with information about the possible languages to filter on.
  • facets=instance,tag -- the response will include a facets object containing an instance object with information about the possible instances to filter on, and a tag object with information about the possible tags to filter on.
keyword
string

Search keyword.

language[]
array of strings

Filter by language (and optionally locale).

Accepts two-letter ISO 639-1 codes for languages in lowercase, and optionally two-letter ISO 3166-1 alpha-2 codes for countries in lowercase, separated by a hyphen.

Examples

  • language[]=hu -- Only return learning objects whose language is Hungarian.
  • language[]=en-gb -- Only return learning objects whose language is English (United Kingdom).
  • language[]=es&language[]=sv -- Only return learning objects whose language is Spanish or Swedish.
location[country][]
array of strings

Only request learning objects that have one or more events that take place in a specific country.

Accepts two-letter ISO 3166-1 alpha-2 codes for countries in uppercase.

Example: AU

location[locality][]
array of strings

Only request learning objects that have one or more events that take place in a specific town.

Example: Brisbane

location[thoroughfare][]
array of strings

Only request learning objects that have one or more events that take place at a specific address.

Example: 64 Adelaide Street

price[min]
number

Filter by minimum price. Will return learning objects with the specified
price or higher.

The value can be an integer or a floating-point number.

price[max]
number

Filter by maximum price. Will return learning objects with the specified
price or lower.

The value can be an integer or a floating-point number.

providers
string

Filter by provider ID(s).

To retrieve provider IDs, first use a ?facets[]=instance&limit=0 query, and use the $.facets.instance.buckets[*].key values from the response.

Examples

  • providers=150 will return learning objects provided by provider #150
  • providers=150,2000 will return learning objects provided by either provider #150 or provider #2000
sort
string

Sort learning objects by one or more properties.

Format: sort=key[:direction][,key[:direction]...]

Available sorting options:

  • created
  • popularity
  • price
  • relevance
  • title

Examples

  • sort=popularity will sort by popularity, showing least popular learning objects first (since no direction is specified)
  • sort=created:desc will sort by creation date, showing most recent learning objects first
  • sort=price:desc,title will sort learning objects first by price in descending order, then by title in ascending order (since no direction is specified)
subscribed
boolean

Filter by subscribed content.

Available values:

  • true: Only return learning objects subscribed to.
  • false: Only return learning objects not subscribed to.
tags[]
array of strings

Filter by content tag(s).

Usage

Use the textual representation of the tags (not tag IDs).

Examples

  • tags[]=Agile will only return learning objects that are tagged with Agile
  • tags[]=Agile&tags[]=Business Skills will return learning objects that are tagged with Agile, Business Skills, or both
type
string

Fiter by one or multiple learning object types.

Format: type=value[,value...]

Examples

  • type=course will only return courses
  • type=learning_resource will only return standalone learning resources, which are not part of any course or module (but not courses)
  • type=course,video will only return courses and videos
topics[]
array of strings

Filter by one or more topics

locale[]
array of strings

DEPRECATED

provider[]
array of integers

DEPRECATED

See providers.

Examples

  • provider[]=150 will return learning objects provided by provider #150
  • provider[]=150&provider[]=2000 will return learning objects provided by either provider #150 or provider #2000
premium
boolean

Filter by premium content.

Available values:

  • true: Attach any premium content to the result set.
  • false: Does not do any attaching of extra content. This is the Default.
id[]
array of integers

Filter by Learning Object ID

updatedAfter
number

Return only items that have been updated after the given timestamp

scroll
boolean

Enables a 1-minute window to iterate over the result set. Use this instead of offset when retrieving large data sets.

scrollId
string

A scroll ID returned by a previous request.
To use this, first send a request with scroll=true, and save the value of the _scroll_id property from the response.
To iterate, send scroll=true and scrollId with this value for each subsequent request.
Extends the window by another minute.

Will return an empty result set if the window has expired or a wrong scroll ID is passed in.

Aggregated data (facets) will not be included.

 
curl --request GET \
  --url https://api.go1.com/v2/learning-objects
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.go1.com/v2/learning-objects' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/learning-objects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/learning-objects");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/learning-objects"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Get learning object details

Detailed information about a learning object (LO).
The schema of the object returned depends on the LO type.
Courses contain modules under items, and modules contain learning items under items.
Learning items themselves have no items.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/learning-objects/lo-id

Path Params

lo-id
integer
required

Learning object ID.

 
curl --request GET \
  --url https://api.go1.com/v2/learning-objects/lo-id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.go1.com/v2/learning-objects/lo-id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/learning-objects/lo-id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/learning-objects/lo-id");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/learning-objects/lo-id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Get preview URL for learning objects

Returns one or more URLs that can be embedded or directly used to preview a learning object.

Can only be requested for learning objects whose previewable property equals true.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/learning-objects/lo-id/preview

Path Params

lo-id
integer
required

Learning object ID.

Query Params

redirect_url
string

After finishing the preview of a scrom file, the user will be redirected to this URL when it is provided

 
curl --request GET \
  --url https://api.go1.com/v2/learning-objects/lo-id/preview
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.go1.com/v2/learning-objects/lo-id/preview' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/learning-objects/lo-id/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/learning-objects/lo-id/preview");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/learning-objects/lo-id/preview"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Download learning object as a SCORM package

Download learning object as a SCORM package.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/learning-objects/lo-id/scorm

Path Params

lo-id
integer
required

Learning object ID.

 
curl --request GET \
  --url https://api.go1.com/v2/learning-objects/lo-id/scorm
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.go1.com/v2/learning-objects/lo-id/scorm' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/learning-objects/lo-id/scorm")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/learning-objects/lo-id/scorm");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/learning-objects/lo-id/scorm"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Enrollments

 
 
 
Suggest Edits

List enrollments

Gets a list of enrollments in the portal.

Note: If the user_id parameter is not present, the authenticated user must be a portal administrator.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/enrollments

Query Params

offset
integer

Offset to start paging from. Offset + limit must not exceed 10,000.

limit
integer

Number of items to return. Maximum value is 50. Each endpoint has a default limit where applicable, so passing in
a value is recommended.

include
string

Request additional data in the response.

Format: include=value[,value...]

Example

  • include=lo will return additional data about the learning object the user (was) enrolled in
lo_ids
string

Filter by learning object ID(s).

Format: lo_ids=value[,value...]

status
string

Fiter by one or multiple enrollment statuses.

Format: status=value[,value...]

Examples

  • status=completed will only return completed enrollments
  • status=not-started,in-progress will only return enrollments that either have not been started or are in progress
updated
number

Filter by changed timestamp so that only enrolments that are greater than or equal to are retrieved.

Example: 1531785600

user_id
integer

Filter by user ID.
If this parameter is not present, the authenticated user must be a portal administrator.

 
curl --request GET \
  --url https://api.go1.com/v2/enrollments
var request = require("request");

var options = { method: 'GET', url: 'https://api.go1.com/v2/enrollments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/enrollments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/enrollments");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/enrollments"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Create a new enrollment

Creates a new enrollment given the user and learning object id.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/enrollments

Body Params

lo_id
integer

Learning object ID to enrol into.

parent_lo_id
integer

Either the course or module learning object ID.

parent_enrollment_id
integer

Either the parent enrollment ID.

user_id
integer

User ID

attributes
object

The points required for an individuals award enrollment

 
attributes.type
string
attributes.date
date
attributes.description
string
attributes.documents
array of objects
name
size
type
url
attributes.award_required
array of objects

Override the points required for an individuals award enrollment

goal_id
value
 
curl --request POST \
  --url https://api.go1.com/v2/enrollments
var request = require("request");

var options = { method: 'POST', url: 'https://api.go1.com/v2/enrollments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/enrollments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/enrollments");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/enrollments"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Create a new award enrollment

Creates a new enrollment given the user and learning object id.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/enrollments/award

Body Params

award_id
integer
required

Award ID to enrol into.

user_id
integer
required

User ID

due_date
integer

Unix timestamp for when the award completion is due

 
curl --request POST \
  --url https://api.go1.com/v2/enrollments/award
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.go1.com/v2/enrollments/award' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/enrollments/award")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/enrollments/award");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/enrollments/award"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Get enrollment details

Gets the enrollment for a given enrollment id.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/enrollments/enrollment-id

Path Params

enrollment-id
integer
required

The enrollment id

 
curl --request GET \
  --url https://api.go1.com/v2/enrollments/enrollment-id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.go1.com/v2/enrollments/enrollment-id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/enrollments/enrollment-id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/enrollments/enrollment-id");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/enrollments/enrollment-id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Update an enrollment

Update an enrollment for a given enrollment id.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
patchhttps://api.go1.com/v2/enrollments/enrollment-id

Path Params

enrollment-id
integer
required

The enrollment id

Body Params

award_required
array of objects

Override the points required for an individuals award enrollment

goal_id
value
 
curl --request PATCH \
  --url https://api.go1.com/v2/enrollments/enrollment-id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.go1.com/v2/enrollments/enrollment-id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/enrollments/enrollment-id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.go1.com/v2/enrollments/enrollment-id");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/enrollments/enrollment-id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Link an existing enrolment to a goal

Update an enrollment for a given enrollment id.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/enrollments/enrollment-id/goal

Path Params

enrollment-id
integer
required

The enrollment id

Body Params

goal_id
integer
value
float
 
curl --request POST \
  --url https://api.go1.com/v2/enrollments/enrollment-id/goal
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.go1.com/v2/enrollments/enrollment-id/goal' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/enrollments/enrollment-id/goal")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/enrollments/enrollment-id/goal");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/enrollments/enrollment-id/goal"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Get enrollment count of learning objects

Get learning objects which have enrollment numbers equal or larger than the provided parameter. Or get enrollment count for the learning object ids provided. At least one of the two parameter needs to be supplied. This endpoint is only available for users with administrator permissions.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/enrollment-aggregates

Query Params

min_enrollment_count
integer

The minimum enrollment count a learning object needs to have

lo_ids[]
array of integers

Learning object IDs.

 
curl --request GET \
  --url https://api.go1.com/v2/enrollment-aggregates
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.go1.com/v2/enrollment-aggregates' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/enrollment-aggregates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/enrollment-aggregates");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/enrollment-aggregates"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Onboarding

 
 
 
Suggest Edits

Creates a new portal as well as a new user account if one doesn't exist. If it does exist, a JWT needs to be passed in.

Onboard a new user, creates new portals

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/onboard

Body Params

creation_path
string
required

Creation path.

Please contact support for more information about possible creation path.

customer
object
required
 
customer.name
string
customer.industry
string

Examples: Aerospace, Agriculture, Chemical, Computer, ...

customer.country
string
customer.stripe_token
string

A stripe CC token if one has been obtained

customer.billing_interval
string

How often does the billing occur. Defaults to annual.

partner_portal_id
integer

Partner portal ID. Only applies to children portals of distribution portals.

portal
object
 
portal.domain
hostname
required

Domain name for the new portal. Must be a first level subdomain to mygo1.com

portal.seats
integer
required

Number of users

portal.administrators
array of strings

Emails for existing accounts that should be added as administrators

portal.notifications
boolean

Option to disable or enable notifications portal wide (defaults to enable - true)

referrer
string

Application name or identifier responsible for creating the portal

user
object
 
user.email
email
required
user.first_name
string
required
user.last_name
string
required
user.password
string
user.phone
string
user.consent
object
 
user.consent.term_privacy
boolean
required
user.consent.term_tos
boolean
required
user.consent.term_collection
boolean
required
additional_users
array of objects

All additional users created will have admin privileges

email
first_name
last_name
password
phone
consent 
 
curl --request POST \
  --url https://api.go1.com/v2/onboard
var request = require("request");

var options = { method: 'POST', url: 'https://api.go1.com/v2/onboard' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/onboard")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/onboard");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/onboard"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
 
 
Suggest Edits

Authenticated user details

Information about the authenticated user

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/me
 
curl --request GET \
  --url https://api.go1.com/v2/me
var request = require("request");

var options = { method: 'GET', url: 'https://api.go1.com/v2/me' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/me")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/me");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/me"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

List users

Retrieves a list of users filtered by the given search criteria

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/users

Query Params

offset
integer

Offset to start paging from. Offset + limit must not exceed 10,000.

limit
integer

Number of items to return. Maximum value is 50. Each endpoint has a default limit where applicable, so passing in
a value is recommended.

first_name
string

First Name

last_name
string

Last Name

email
string

E-mail

roles[]
array of strings

Roles

 
curl --request GET \
  --url https://api.go1.com/v2/users
var request = require("request");

var options = { method: 'GET', url: 'https://api.go1.com/v2/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/users");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/users"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Create new user

Will create a new user. An email will be sent to the user for them to login and set their password.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/users

Body Params

email
string
required
first_name
string
required
last_name
string
required
roles
array of strings

Roles

send_login_email
boolean

Defaults to true. Will send an email with a link allowing the user to login into GO1 and set his password.

custom_fields
object

Custom fields that have been created in the system.

Note: non-existent custom fields will be ignored.

 
managers
array of integers

An array of managers' accountIDs for this user.

 
curl --request POST \
  --url https://api.go1.com/v2/users
var request = require("request");

var options = { method: 'POST', url: 'https://api.go1.com/v2/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/users");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/users"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Update user

Update user record

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
patchhttps://api.go1.com/v2/users/user-id

Path Params

user-id
integer
required

User identifier number.

Body Params

status
boolean

When false the user is blocked

roles
array of strings

Roles

custom_fields
object

Custom fields that have been created in the system.

Note: non-existent custom fields will be ignored.

 
managers
array of integers

An array of managers' accountIDs for this user. The manager's list will be replaced with the one sent. Existing managers not included in the update list will be removed.

 
curl --request PATCH \
  --url https://api.go1.com/v2/users/user-id
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.go1.com/v2/users/user-id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/users/user-id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.go1.com/v2/users/user-id");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/users/user-id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Get user details

Get the user record

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/users/user-id

Path Params

user-id
integer
required

User identifier number.

 
curl --request GET \
  --url https://api.go1.com/v2/users/user-id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.go1.com/v2/users/user-id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/users/user-id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/users/user-id");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/users/user-id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Generate login link

Generate a single use login URL for a user. This is not enabled by default, please contact [email protected] for access.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/users/user-id/login

Path Params

user-id
integer
required

User identifier number.

 
curl --request POST \
  --url https://api.go1.com/v2/users/user-id/login
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.go1.com/v2/users/user-id/login' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/users/user-id/login")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/users/user-id/login");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/users/user-id/login"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
 
 
 
Suggest Edits

List webhooks

Retrieves a list of webhooks limited to 5 webhooks

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/webhooks
 
curl --request GET \
  --url https://api.go1.com/v2/webhooks
var request = require("request");

var options = { method: 'GET', url: 'https://api.go1.com/v2/webhooks' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/webhooks");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/webhooks"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Create new webhook

Will create a new webhook.

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
posthttps://api.go1.com/v2/webhooks
 
curl --request POST \
  --url https://api.go1.com/v2/webhooks
var request = require("request");

var options = { method: 'POST', url: 'https://api.go1.com/v2/webhooks' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.go1.com/v2/webhooks");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/webhooks"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Update webhook

Update webhook object

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
patchhttps://api.go1.com/v2/webhooks/webhook-id

Path Params

webhook-id
integer
required

Webhook identifier number.

Body Params

enrollment_create
boolean
enrollment_delete
boolean
enrollment_update
boolean
lo_create
boolean
lo_delete
boolean
lo_update
boolean
enabled
boolean
url
string
user_create
boolean
user_delete
boolean
user_update
boolean
content_update
boolean
 
curl --request PATCH \
  --url https://api.go1.com/v2/webhooks/webhook-id
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.go1.com/v2/webhooks/webhook-id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/webhooks/webhook-id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.go1.com/v2/webhooks/webhook-id");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/webhooks/webhook-id"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Get webhook details

Get the webhook record

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
gethttps://api.go1.com/v2/webhooks/webhook-id

Path Params

webhook-id
integer
required

Webhook identifier number.

 
curl --request GET \
  --url https://api.go1.com/v2/webhooks/webhook-id
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.go1.com/v2/webhooks/webhook-id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/webhooks/webhook-id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.go1.com/v2/webhooks/webhook-id");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/webhooks/webhook-id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results
 
Suggest Edits

Delete a webhook

Delete a webhook record

 

OAuth2 Auth

Bearer
 Authentication is required for this endpoint.
deletehttps://api.go1.com/v2/webhooks/webhook-id

Path Params

webhook-id
integer
required

Webhook identifier number.

 
curl --request DELETE \
  --url https://api.go1.com/v2/webhooks/webhook-id
var request = require("request");

var options = { method: 'DELETE',
  url:
   'https://api.go1.com/v2/webhooks/webhook-id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.go1.com/v2/webhooks/webhook-id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.go1.com/v2/webhooks/webhook-id");

xhr.send(data);
import requests

url = "https://api.go1.com/v2/webhooks/webhook-id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

Your OAuth2 token is incorrect or has expired

Try the API to see results