{"info":{"_postman_id":"323a24e8-eb03-49d8-b3ee-c20a87f3268e","name":"Inspire360 LMS APIs","description":"

Inspire360 APIs for users, enrollments, workshops, and orders.

\n

Contact your Inspire360 account manager to get started!

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18139","collectionId":"323a24e8-eb03-49d8-b3ee-c20a87f3268e","publishedId":"SVtZvRvg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-10-17T19:12:39.000Z"},"item":[{"name":"Create Authorization Token","id":"50b8907c-6f59-4572-b6b7-0d055017dec8","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true,"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"loginType\": \"internal\",\n\"loginId\": \"string\",\n\"secret\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/authorizations","description":"

Create Bearer Token

\n

Endpoint: /api.v3/authorizations

\n

Method: POST

\n

Parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
loginTypestringUse \"internal\"
loginIdstringEmail address of account being used to access endpoint
secretstringLogin password of account being used to access endpoint
\n

Extended Description

\n

Obtain a bearer token for the account making the API calls.

\n

You will use the returned bearer token in the authorization header when calling the other /api.v3 endpoints.

\n","urlObject":{"protocol":"https","path":["api.v3","authorizations"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"1d55d595-eeb2-4014-81d3-4d55ec83f1c4","name":"Create Authorization Token","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"loginType\": \"internal\",\n\"loginId\": \"string\",\n\"secret\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/authorizations"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJIUzI...\",\n \"tokenType\": \"Bearer\",\n \"expiresIn\": \"300\",\n \"jwtId\": \"2da3b569-9623-453a-8e99-47b777fc847e\"\n}"}],"_postman_id":"50b8907c-6f59-4572-b6b7-0d055017dec8"},{"name":"Refresh Authorization Token","id":"a70323fe-10bc-4140-bd48-4974bdf63c91","protocolProfileBehavior":{"disabledSystemHeaders":{"content-type":true,"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jwt\" : \"JWT Token\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/authorizations","description":"

Refresh Bearer Token

\n

Endpoint: /api.v3/authorizations

\n

Method: PUT

\n

Parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
jwtstringJWT token to be refreshed
\n
","urlObject":{"protocol":"https","path":["api.v3","authorizations"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"84b45552-6203-41d4-8f80-b565f7005d17","name":"Refresh Authorization Token","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"jwt\" : \"JWT Token\"\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/authorizations"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"eyJhbGciOiJIUzI...\",\n \"tokenType\": \"Bearer\",\n \"expiresIn\": \"300\",\n \"jwtId\": \"2da3b569-9623-453a-8e99-47b777fc847e\"\n}"}],"_postman_id":"a70323fe-10bc-4140-bd48-4974bdf63c91"},{"name":"Create User Account","id":"70c96bb4-e6b1-4c19-ac62-caedf4941512","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"externalReferenceId\": \"string\",\n \"address\": {\n \"company\": \"string\",\n \"street1\": \"string\",\n \"street2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"countryCode\": \"string\",\n \"phone\": \"string\"\n }\n}"},"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/accounts","description":"

Create a new user

\n\n

Endpoint: /api.v3/accounts

\n\n

Method: POST

\n\n

Request Payload:

\n\n
Name
Type
Description

email

String (required)

Email address

firstName

String (required)

First name

lastName

String (required)

Last name

externalReferenceId

String

Unique customer ID in the originating system

address

Object

Not required, but if included in post, then street1, city, and province are required

company

String

Company

street1

String (

Address line 1

street2

String

Address line 2

city

String

City

province

String

Province/state

postalCode

String

Postal/zip code

countryCode

String

Two-character Country Code (https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)

phone

String

Primary phone number
\n\n

Extended Description

\n\n

Creates a new user. Email address must be unique.

\n\n

Response

\n\n

Returns HTTP 200 on success.
\"accountId\" : \"uuid\"

\n\n
\n
Name
Type
Description

accountId

String

Unique customer ID in Inspire360 system
","urlObject":{"protocol":"https","path":["api.v3","accounts"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"5d377d01-0d28-47ea-9115-f75088ae632f","name":"Create User Account","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"externalReferenceId\": \"string\",\n \"address\": {\n \"company\": \"string\",\n \"street1\": \"string\",\n \"street2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"countryCode\": \"string\",\n \"phone\": \"string\"\n }\n}"},"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/accounts"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"createdOn\": \"string\",\n \"accountId\": \"string\"\n}"}],"_postman_id":"70c96bb4-e6b1-4c19-ac62-caedf4941512"},{"name":"Account Lookup","id":"c2aff861-277c-4984-acdc-c22b161fad7a","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/accounts/logins/internal/{{exampleEmail}}","description":"

Find user by email address

\n

Description:

\n

This endpoint can be used to query the system to see if an account exists for the specified email address.

\n

Response:

\n

Code: 200

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
idstringAccount ID
emailstringEmail address
firstNamestringFirst name
lastNamestringLast name
\n

Code: 404

\n

Message \"Account reference does not exist\"

\n

(The email address specified in the request does not exist)

\n","urlObject":{"protocol":"https","path":["api.v3","accounts","logins","internal","{{exampleEmail}}"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"f4e5d148-1e3b-4bdc-9a87-6e6dfee56669","name":"Account Lookup","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/accounts/logins/internal/{{exampleEmail}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\"\n}"}],"_postman_id":"c2aff861-277c-4984-acdc-c22b161fad7a"},{"name":"Retrieve an Account","id":"006844fd-fe9a-42e0-b70c-879c654cc82a","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/accounts/{{accountId}}","description":"

Retrieve an account by ID.

\n

Description:

\n

This endpoint can be used to retrieve basic account details.

\n

Response:

\n

Code: 200

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
idstringAccount ID
emailstringEmail address
firstNamestringFirst name
lastNamestringLast name
\n

Code: 404

\n

Message \"Account reference does not exist\"

\n

(The account ID specified in the request does not exist)

\n","urlObject":{"protocol":"https","path":["api.v3","accounts","{{accountId}}"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"1fec6a86-3580-47d1-b9c1-131287bd6627","name":"Retrieve an Account","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/accounts/{{accountId}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"email\": \"string\",\n \"firstName\": \"string\",\n \"lastName\": \"string\"\n}"}],"_postman_id":"006844fd-fe9a-42e0-b70c-879c654cc82a"},{"name":"Currencies","id":"791ba629-e833-4530-a572-ae612d6c5cb9","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/currencies","description":"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
codestringThree letter ISO 4217 currency code. For example, \"USD\"
format
thousandsSeparatorstringThe character used as the thousands separator. For example, \",\"
decimalSeparatorstringThe character used as the decimal separator. For example, \".\"
decimalPlacesintegerThe number of digits after the decimal separator.
namestringThe name of the currency.
\n

Extended Description: Retrieve a list of ISO 4217 currencies.

\n","urlObject":{"protocol":"https","path":["api.v3","currencies"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"a4bda74c-e645-4ab4-8100-9ba8e4640660","name":"Currencies","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/currencies"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": \"string\",\n \"format\": \"string\",\n \"thousandsSeparator\": \"string\",\n \"decimalSeparator\": \"string\",\n \"decimalPlaces\": 0,\n \"name\": \"string\"\n }\n]"}],"_postman_id":"791ba629-e833-4530-a572-ae612d6c5cb9"},{"name":"Enrollments","id":"c161bb55-cc5d-4a61-9bc2-bd1e2e2bccfd","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/enrollments","description":"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
idstringUUID of the enrollment.
accountIdstringUUID of the user.
educationIdstringUUID of the education node.
productIdstringUUID of the product.
skustringProduct SKU.
statusstringUser's enrollment status.
Status include:
\"enrolled\" - user is enrolled in the course.
\"passed\" - user has passed the course.
\"failed\" - user has not passed the course.
enrollmentDatedate/timeDate/time the user started taking the course.
For example, \"2012-07-23 15:15:13\"
completedDatedate/timeDate/time the user completed the course. Only returned when the status is either \"passed\" or \"failed\".
For example, \"2018-07-18 09:03:25\"
\n
","urlObject":{"protocol":"https","path":["api.v3","enrollments"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"69d854e6-fed1-417b-a1de-d7ed330ee3a2","name":"enrollments","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/enrollments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Oct 2024 21:16:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"vary","value":"Accept-Encoding"},{"key":"request-id","value":"3a895318e1ea4b07869016224999a4f4"},{"key":"x-server","value":"dapr-57f5796f8-7nchf"},{"key":"x-project","value":"IdeafitAPI/opt"},{"key":"content-md5","value":"37a96f48e241a0d1b53cbdf8a855a703"},{"key":"x-powered-by","value":"Dapr"},{"key":"access-control-expose-headers","value":"X-Server,X-Project,X-ObjectId,Content-MD5"},{"key":"Content-Encoding","value":"gzip"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d644563a87552b9-LAX"}],"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"pages\": 0,\n \"limit\": 0,\n \"count\": 0,\n \"total\": 0,\n \"data\": [\n {\n \"id\": \"string\",\n \"accountId\": \"string\",\n \"educationId\": \"string\",\n \"productId\": \"string\",\n \"sku\": \"string\",\n \"status\": \"string\",\n \"enrollmentDate\": \"string\",\n \"completedDate\": \"string\"\n }\n ]\n}"}],"_postman_id":"c161bb55-cc5d-4a61-9bc2-bd1e2e2bccfd"},{"name":"Enrollment","id":"96a4bc6d-9efc-4f7e-8d3d-c16dd6b9a216","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/enrollments/{id}","description":"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeDescription
idstringUUID of the enrollment.
accountIdstringUUID of the user.
educationIdstringUUID of the education node.
productIdstringUUID of the product.
skustringProduct SKU.
statusstringUser's enrollment status.
Status include:
\"enrolled\" - user is enrolled in the course.
\"passed\" - user has passed the course.
\"failed\" - user has not passed the course.
enrollmentDatedate/timeDate/time the user started taking the course.
For example, \"2012-07-23 15:15:13\"
completedDatedate/timeDate/time the user completed the course. Only returned when the status is either \"passed\" or \"failed\".
For example, \"2018-07-18 09:03:25\"
\n
","urlObject":{"protocol":"https","path":["api.v3","enrollments","{id}"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"fe5fafd9-2422-40a7-8d12-dac8844e3a21","name":"enrollment","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/enrollments/ddee1bb0-c804-11ec-8dad-3ca82a13e96c"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 21 Oct 2024 21:21:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Accept-Encoding"},{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"request-id","value":"d749412bf0a34a94816ed2df2bf9bc7d"},{"key":"x-server","value":"dapr-57f5796f8-gnpb4"},{"key":"x-project","value":"IdeafitAPI/opt"},{"key":"content-md5","value":"c57cc019e99c453952e4087164771abf"},{"key":"x-powered-by","value":"Dapr"},{"key":"access-control-expose-headers","value":"X-Server,X-Project,X-ObjectId,Content-MD5"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d644b76ada22f5e-LAX"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"accountId\": \"string\",\n \"educationId\": \"string\",\n \"productId\": \"string\",\n \"sku\": \"string\",\n \"status\": \"string\",\n \"enrollmentDate\": \"string\",\n \"completedDate\": \"string\"\n}"}],"_postman_id":"96a4bc6d-9efc-4f7e-8d3d-c16dd6b9a216"},{"name":"Create Order","id":"622727b9-6d23-4932-aacf-69a5ac1676e4","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"text/json"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"string\",\n \"orderDate\": \"string\",\n \"externalOrderId\": \"string\",\n \"total\": {\n \"currency\": \"string\",\n \"value\": 0\n },\n \"items\": [\n {\n \"sku\": \"string\",\n \"title\": \"string\",\n \"quantity\": 0,\n \"price\": {\n \"currency\": \"string\",\n \"value\": 0\n },\n \"itemType\": \"Mapped\"\n }\n ],\n \"source\": \"api\",\n \"sourceId\": \"string\"\n}"},"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/orders","description":"

Create a new order

\n\n

Endpoint: /api.v3/orders

\n\n

Method: POST

\n\n

Parameters:

\n\n
Name
Type
Description

accountId

string (required)

Unique user ID in the Inspire360 system

orderDate

string (required)

ISO 8601 standard
Example: 2019-09-07T15:50-04:00

externalOrderId

string (required)

Unique order ID in the originating system

total

object (required)

Total amount charged for the order

currency

string

ISO 4217 Alphabetic code
Example: USD

value

integer

Amount (as integer) in the given currency, represented in the smallest unit available in the currency. Example 100 for 1.00 USD

items

object (required)

sku

string

Unique item code

title

string

Title of item

quantity

integer

Quantity of item

price

object

Price of item

currency

string

ISO 4217 Alphabetic code
Example: USD

value

integer

Amount (as integer) in the given currency, represented in the smallest unit available in the currency. Example 100 for 1.00 USD
itemType
string
Accepted values: Mapped, Not Mapped, Tax, Shipping, Discount

Mapped items will be processed in the Inspire360 system. All other item types are for informational purposes only
source
string
Default: \"api\"
sourceId
string
Not currently used
\n\n

Extended Description

\n\n

Creates a new order.

\n\n

Response

\n\n

Returns HTTP 200 on success.

","urlObject":{"protocol":"https","path":["api.v3","orders"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"622727b9-6d23-4932-aacf-69a5ac1676e4"},{"name":"Products","id":"278c959e-7ecf-4669-8580-c4b627f678e1","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/products","description":"

Retrieve all products on your site.

\n","urlObject":{"protocol":"https","path":["api.v3","products"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"3e216267-6e68-48d0-9115-b1c6e50fafad","name":"api.v3/products","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Oct 2024 22:43:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"vary","value":"Accept-Encoding"},{"key":"request-id","value":"df129f98718949e7a1c9d55ece9100e2"},{"key":"x-server","value":"dapr-b95795f88-jprgn"},{"key":"x-project","value":"IdeafitAPI/opt"},{"key":"content-md5","value":"b41ee998f87091026e192a0f9bef8f1d"},{"key":"x-powered-by","value":"Dapr"},{"key":"access-control-expose-headers","value":"X-Server,X-Project,X-ObjectId,Content-MD5"},{"key":"Content-Encoding","value":"gzip"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d4c0c888c202ecc-LAX"}],"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"pages\": 0,\n \"limit\": 0,\n \"count\": 0,\n \"total\": 0,\n \"data\": [\n {\n \"id\": \"string\",\n \"title\": \"string\",\n \"educationId\": \"string\",\n \"sku\": \"string\",\n \"price\": {\n \"displayAmount\": \"string\",\n \"currency\": \"string\",\n \"value\": 0\n },\n \"type\": \"string\",\n \"url\": \"string\",\n \"description\": \"string\",\n \"imageUrl\": \"string\",\n \"subdomainContentOwner\": \"string\",\n \"availableForPurchase\": false,\n \"visible\": false,\n \"categories\": [\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"278c959e-7ecf-4669-8580-c4b627f678e1"},{"name":"Product","id":"07c46d3e-c44c-4c9d-a5a3-f2a90105c679","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/products/{id}","description":"

Retrieve a specific product on your site.

\n","urlObject":{"protocol":"https","path":["api.v3","products","{id}"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"a27c6ca3-8342-42de-bf7e-a78281499c61","name":"api.v3/products Copy","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/products/8b862002-5f1c-11ef-af01-a61e2532f714"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Oct 2024 22:46:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"vary","value":"Origin"},{"key":"vary","value":"Access-Control-Request-Method"},{"key":"vary","value":"Access-Control-Request-Headers"},{"key":"vary","value":"Accept-Encoding"},{"key":"request-id","value":"ff2f87c14cf54d7eb3bb550f6f658283"},{"key":"x-server","value":"dapr-b95795f88-n9sjk"},{"key":"x-project","value":"IdeafitAPI/opt"},{"key":"content-md5","value":"3082edc7e126ae76bb879399fcf1bdb4"},{"key":"x-powered-by","value":"Dapr"},{"key":"access-control-expose-headers","value":"X-Server,X-Project,X-ObjectId,Content-MD5"},{"key":"Content-Encoding","value":"gzip"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Set-Cookie","value":"__cf_bm=O96qGUaUt28zw9BF7DuYwwivSlIHFp7ZGHabzjBlJzQ-1729291567-1.0.1.1-qHSxMpCRVPXiJHyAH2K_IunaIiSQ3_BRu1e3YZDeHdE8vu1J6ZamYmk3HYO0FNyrHJyCreQ5BE0fkBkyxQ.7sQ; path=/; expires=Fri, 18-Oct-24 23:16:07 GMT; domain=.inspire360.com; HttpOnly; Secure; SameSite=None"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8d4c1005e95408a7-LAX"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"string\",\n \"title\": \"string\",\n \"educationId\": \"string\",\n \"sku\": \"string\",\n \"price\": {\n \"displayAmount\": \"string\",\n \"currency\": \"string\",\n \"value\": 0\n },\n \"type\": \"string\",\n \"url\": \"string\",\n \"description\": \"string\",\n \"imageUrl\": \"string\",\n \"subdomainContentOwner\": \"string\",\n \"availableForPurchase\": false,\n \"visible\": false,\n \"categories\": [\n {\n \"id\": \"string\",\n \"name\": \"string\"\n }\n ]\n}"}],"_postman_id":"07c46d3e-c44c-4c9d-a5a3-f2a90105c679"},{"name":"Workshop Instances","id":"2f74779c-5684-4d7c-9ba8-bec99973efb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"},{"key":"Origin","value":"{{origin}}","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/workshops/instances","description":"

Retrieve workshop instances.

\n\n

Endpoint: /api.v3/workshops/instances

\n\n

Method: GET

\n\n

Parameters:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription

status

string

By default it is ‘Active’, but can be ‘Pending’, ‘Cancelled’, ‘Completed’

startsAfter

string

Any value that you can pass to php DateTime class (e.g. ‘2019-07-01 10:00:00-0700’, ‘tomorrow’, ‘yesterday’, etc)

location

string

Any value that google can geolocate: https://developers.google.com/maps/documentation/geolocation/intro#body

radius

integer

Value in miles

sku

string

Workshop instance SKU

externalId

string

Client’s external ID for the workshop instance, such as a SalesForceID.

registrationOpen

string

True if registrationEnds value is in the future; False if registrationEnds value is in the past

\n \n

Response:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription

instanceId

string

Our internal unique ID for workshop instance

externalId

string

Client’s external ID for the workshop instance, such as a SalesForceID.

name

string

Name of workshop instance

sku

string

Workshop instance SKU

price

string

Price of workshop instance in USD

source

string

Host server name

status

string

Workshop instance status. Values include: \"Pending\", \"Active\", \"Cancelled\", \"Completed\"

imageUrl

string

Image URL of workshop instance

capacity

integer

Number of users who can enroll in the workshop instance

enrolled

integer

Number of users currently enrolled in the workshop instance

startTime

date/time

Start date time of workshop. Example: 2019-09-06T19:00:00+0000

endTime

date/time

End date time of workshop. Example: 2019-09-08T22:00:00+0000

dates.description

string

Used for workshops that span multiple days. Name of workshop time slote. Example: “Friday's Form Class”

dates.start

date/time

Used for workshops that span multiple days. Start time of workshop within timeslot. Example: 2019-09-06T19:00:00+0000

dates.end

date/time

Used for workshops that span multiple days.\nEnd time of workshop within timeslot. Example: 2019-09-06T23:00:00+0000\n

dates.start

date/time

Used for workshops that span multiple days. Start time of workshop within timeslot. Example: 2019-09-06T19:00:00+0000

registrationOpen

boolean

True if registrationEnds value is in the future; False if registrationEnds value is in the past

registrationEnds

date/time

End date time of when workshop can be purchased. Often set to the same date time as the workshop end date.

instructors.instructorId

string

Our internal unique ID for the instructor

instructors.name

string

Instructor’s name

hostFacility.externalId

string

Client’s external ID for the facility, such as a SalesForceID.

hostFacility.imageUrl

string

Image path of the facility

hostFacility.status

string

Facility status.

address.firstName

string

Facility address first name (most likely blank)

address.lastName

string

Facility address last name (most likely blank)

address.street1

string

Facility street address

address.street2

string

Facility street address 2

address.city

string

Facility city

address.province

string

Facility province. Two letter state code in most cases.

address.postalCode

string

Facility zip code

address.countryCode

string

Facility country code

address.phone

string

Facility phone number
\n

Response

\n

Returns HTTP 200 on success.

\n
\n

Extended Description

\n

Returns workshop instances in JSON.

\n\n
","urlObject":{"protocol":"https","path":["api.v3","workshops","instances"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"0aa0aec5-6d41-4a11-bc44-9761260919ab","name":"Workshop Instances","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"},{"key":"Origin","value":"{{origin}}","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/workshops/instances"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"start\": 1,\n \"limit\": 1,\n \"total\": 1,\n \"items\": [\n {\n \"instanceId\": \"string\",\n \"price\": \"string\",\n \"source\": \"string\",\n \"capacity\": integer,\n \"enrolled\": integer,\n \"atCapacity\": false,\n \"dates\": [\n {\n \"description\": \"string\",\n \"start\": \"string\",\n \"end\": \"string\"\n },\n {\n \"description\": \"string\",\n \"start\": \"string\",\n \"end\": \"string\"\n }\n ],\n \"instructors\": [\n {\n \"instructorId\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"categories\": [\n \"string\"\n ],\n \"internalCategories\": [\n \"string\"\n ]\n \"externalId\": \"string\",\n \"workshopExternalId\": \"string\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"status\": \"string\",\n \"imageUrl\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\",\n \"registrationOpen\": true,\n \"timezone\": \"string\",\n \"hostFacility\": {\n \"name\": \"string\",\n \"externalId\": \"string\",\n \"imageUrl\": \"string\",\n \"status\": \"string\"\n },\n \"address\": {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"street1\": \"string\",\n \"street2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"countryCode\": \"string\",\n \"phone\": \"string\"\n }\n \"webinarUrl\": \"string\",\n \"webinarUrlPostEvent\": \"string\"\n }\n ]\n}"}],"_postman_id":"2f74779c-5684-4d7c-9ba8-bec99973efb7"},{"name":"Workshop Instance","id":"480b0df2-aaf1-4568-a21e-e01163f9a09c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"},{"key":"Origin","value":"{{origin}}","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/workshops/instances/{id}","description":"

Retrieve workshop instance.

\n\n

Endpoint: /api.v3/workshops/instances/id

\n\n

Method: GET

\n\n

Parameters:

\n\n
Name
Type
Description

status

string

By default it is ‘Active’, but can be ‘Pending’, ‘Cancelled’, ‘Completed’

startsAfter

string

Any value that you can pass to php DateTime class (e.g. ‘2019-07-01 10:00:00-0700’, ‘tomorrow’, ‘yesterday’, etc)

location

string

Any value that google can geolocate: https://developers.google.com/maps/documentation/geolocation/intro#body

radius

integer

Value in miles

sku

string

Workshop instance SKU

externalId

string

Client’s external ID for the workshop instance, such as a SalesForceID.

registrationOpen

string

True if registrationEnds value is in the future; False if registrationEnds value is in the past

\n\n

Response:

\n\n
Name
Type
Description

instanceId

string

Our internal unique ID for workshop instance

externalId

string

Client’s external ID for the workshop instance, such as a SalesForceID.

name

string

Name of workshop instance

sku

string

Workshop instance SKU

price

string

Price of workshop instance in USD

source

string

Host server name

status

string

Workshop instance status. Values include: \"Pending\", \"Active\", \"Cancelled\", \"Completed\"

imageUrl

string

Image URL of workshop instance

capacity

integer

Number of users who can enroll in the workshop instance

enrolled

integer

Number of users currently enrolled in the workshop instance

startTime

date/time

Start date time of workshop. Example: 2019-09-06T19:00:00+0000

endTime

date/time

End date time of workshop. Example: 2019-09-08T22:00:00+0000

dates.description

string

Used for workshops that span multiple days. Name of workshop time slote. Example: “Friday's Form Class”

dates.start

date/time

Used for workshops that span multiple days. Start time of workshop within timeslot. Example: 2019-09-06T19:00:00+0000

dates.end

date/time

Used for workshops that span multiple days.
End time of workshop within timeslot. Example: 2019-09-06T23:00:00+0000

dates.start

date/time

Used for workshops that span multiple days. Start time of workshop within timeslot. Example: 2019-09-06T19:00:00+0000

registrationOpen

boolean

True if registrationEnds value is in the future; False if registrationEnds value is in the past

registrationEnds

date/time

End date time of when workshop can be purchased. Often set to the same date time as the workshop end date.

instructors.instructorId

string

Our internal unique ID for the instructor

instructors.name

string

Instructor’s name

hostFacility.externalId

string

Client’s external ID for the facility, such as a SalesForceID.

hostFacility.imageUrl

string

Image path of the facility

hostFacility.status

string

Facility status.

address.firstName

string

Facility address first name (most likely blank)

address.lastName

string

Facility address last name (most likely blank)

address.street1

string

Facility street address

address.street2

string

Facility street address 2

address.city

string

Facility city

address.province

string

Facility province. Two letter state code in most cases.

address.postalCode

string

Facility zip code

address.countryCode

string

Facility country code

address.phone

string

Facility phone number
\n\n

Response

\n\n

Returns HTTP 200 on success.

\n\n

Extended Description

\n\n

Returns workshop instances in JSON.

\n\n
\n","urlObject":{"protocol":"https","path":["api.v3","workshops","instances","{id}"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[{"id":"147caa4e-63fa-4b7c-a640-f553fbe53551","name":"Workshop Instance","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"},{"key":"Origin","value":"{{origin}}","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/workshops/instances"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"instanceId\": \"string\",\n \"price\": \"string\",\n \"source\": \"string\",\n \"capacity\": integer,\n \"enrolled\": integer,\n \"atCapacity\": false,\n \"dates\": [\n {\n \"description\": \"string\",\n \"start\": \"string\",\n \"end\": \"string\"\n },\n {\n \"description\": \"string\",\n \"start\": \"string\",\n \"end\": \"string\"\n }\n ],\n \"instructors\": [\n {\n \"instructorId\": \"string\",\n \"name\": \"string\"\n }\n ],\n \"categories\": [\n \"string\"\n ],\n \"internalCategories\": [\n \"string\"\n ]\n \"externalId\": \"string\",\n \"workshopExternalId\": \"string\",\n \"name\": \"string\",\n \"sku\": \"string\",\n \"status\": \"string\",\n \"imageUrl\": \"string\",\n \"startTime\": \"string\",\n \"endTime\": \"string\",\n \"registrationOpen\": true,\n \"timezone\": \"string\",\n \"hostFacility\": {\n \"name\": \"string\",\n \"externalId\": \"string\",\n \"imageUrl\": \"string\",\n \"status\": \"string\"\n },\n \"address\": {\n \"firstName\": \"string\",\n \"lastName\": \"string\",\n \"street1\": \"string\",\n \"street2\": \"string\",\n \"city\": \"string\",\n \"province\": \"string\",\n \"postalCode\": \"string\",\n \"countryCode\": \"string\",\n \"phone\": \"string\"\n }\n \"webinarUrl\": \"string\",\n \"webinarUrlPostEvent\": \"string\"\n}"}],"_postman_id":"480b0df2-aaf1-4568-a21e-e01163f9a09c"},{"name":"api.v3/subscriptions/videos","id":"f5f34a63-787f-41a5-bd89-7128c731b8e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"},{"key":"Origin","value":"{{origin}}","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/subscriptions/videos/","description":"

Retrieve subscription video content.

\n\n

Endpoint: /api.v3/subscriptions/videos

\n\n

Method: GET

\n\n

Parameters:

\n\n \n \n \n \n \n \n \n \n \n \n
NameTypeDescription

Subscription ObjectId

number

Mongo ObjectId of the subscription for the node.

\n \n

Response:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
NameTypeDescription

id

string

Unique ID of the content

title

string

Title of the content

type

string

Type of content (e.g. \"video\")

url

string

URL of the video content

categories

array of strings

Category terms content is tagged with

imageUrl

string

Full URL path of image

description

string

Desription of content

dateAdded

string

Date content added to the subscription

rating

integer

Average 5 star rating

ratingCount

integer

Number of ratings

subscriptionId

string

Subcription Id of the content

isNew

boolean

True if video has been tagged as new
\n

Response

\n

Returns HTTP 200 on success.

\n
\n

Extended Description

\n

Returns subscription content in JSON.

\n\n
","urlObject":{"protocol":"https","path":["api.v3","subscriptions","videos",""],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f5f34a63-787f-41a5-bd89-7128c731b8e9"},{"name":"api.v3/imports","id":"a3d4c49b-d749-4b8c-b8f5-6bbe4a8792d1","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{jwtToken}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"text/json","type":"text"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/api.v3/imports/{id}","urlObject":{"protocol":"https","path":["api.v3","imports","{id}"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a3d4c49b-d749-4b8c-b8f5-6bbe4a8792d1"},{"name":"courseplus/user","event":[{"listen":"test","script":{"id":"b526689a-6667-4fd5-bf81-06d69b9c18ba","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","tests[\"Response time is less than 200ms\"] = responseTime < 500;"],"type":"text/javascript"}}],"id":"b5ca932c-e461-4587-91c1-11aa47bb880d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Access-Token","value":"{{apiToken}}"},{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"},{"key":"siteId","value":"{{siteId}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"siteId\": {{siteId}},\n \"firstName\": \"Jane\",\n \"lastName\": \"Smith\",\n \"email\": \"{{exampleEmail}}\"\n}"},"url":"https://{{subdomain}}.inspire360.{{domain}}/courseplus/user","description":"

Create a user.

Endpoint: /courseplus/user (Deprecated)

Method: POST

Parameters:

NameTypeDescription

siteId

Integer (required)

Inspire360 issued site ID

firstName

String (required)

User's first name.

lastName

String (required)

User's last name.

email

String (required)

User's email address.

Extended Description

Creates a new user.

Response

Returns HTTP 200 on success.

\n\n
\n","urlObject":{"protocol":"https","path":["courseplus","user"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b5ca932c-e461-4587-91c1-11aa47bb880d"},{"name":"courseplus/order","id":"bf976e7f-6303-48a3-b764-3e1d9942f621","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"X-Access-Token","value":"{{apiToken}}"},{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"siteId\": {{siteId}},\r\n \"fitconnectId\": \"{{exampleUser}}\",\r\n \"customerNumber\": 808,\r\n \"purchaseDate\": \"2023-02-27 13:49:00\",\r\n \"orderNumber\": 776,\r\n\t\"items\": [\r\n\t\t{\r\n \t\t\"SKU\": \"{{exampleSKU}}\",\r\n \t\t\"price\": 75.00,\r\n \t \t\"quantity\": 1\r\n\t\t}\r\n\t],\r\n \"address\": [\r\n {\r\n \"type\": \"Shipping\",\r\n \"firstName\": \"Jane\",\r\n \"lastName\": \"Doe\",\r\n \"street1\": \"123 Test St.\",\r\n \"street2\": \"\",\r\n \"city\": \"San Diego\",\r\n \"state\": \"California\",\r\n \"zip\": \"92007\",\r\n \"country\": \"US\",\r\n \"phone\": \"\"\r\n }\r\n ]\r\n}\r\n\r\n"},"url":"https://{{subdomain}}.inspire360.{{domain}}/courseplus/order","description":"

Create an order.

Endpoint: /courseplus/order (Deprecated)

Method: POST

Parameters:

siteId

Integer (required)

Inspire360 issued site ID

fitconnectId

String (required)

Used as the primary identifier between systems; Format \"fcXXXXXXXXXXXX\" (where 'X' represents any alphanumeric character)

customerNumber

Integer (required)

Unique customer ID in the partner's system

purchaseDate

Date (required);
MM/DD/YYYY HH:MM

Date the purchase was made

orderNumber

Integer (required)

Order number

items

    item

        SKU

String (required)

Inspire360 SKU of the product.

        price

Decimal (required)

Price of the product; eg. 99.00. The amount paid for the product by the customer.

        quantity

Integer (required)

Quantity of the product; integer greater than zero. In most cases this should be one.

address

    type

String (required)

\"Shipping\"

    firstName

String (required)

First name

    lastName

String (required)

Last name

    street1

String (required)

Street address

    street2

String

Street address

    city

String (required)

City

    state

String (required)

State

    zip

String (required)

Zip code

    county

String (required)

Country code (ISO 3166-1)

    phone

String

Phone number

Extended Description

Creates a new order.

Returns the orderId of the newly created order.

Response

Returns HTTP 200 on success.

\n\n
\n","urlObject":{"protocol":"https","path":["courseplus","order"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf976e7f-6303-48a3-b764-3e1d9942f621"},{"name":"courseplus/user","id":"9b6b0a7e-10bf-4311-92f8-0206a025047d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Access-Token","value":"{{apiToken}}"},{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/courseplus/user?siteId={{siteId}}&email={{exampleEmail}}","description":"

Get a user's details.

Endpoint: /courseplus/user (Deprecated)

Method: GET

Parameters:

NameTypeDescription

siteId

String (required)

Inspire360 issued site ID.

email

String

User's email address.

fitconnectId

String

Used as the primary identifier between systems; Format \"fcXXXXXXXXXXXX\" (where 'X' represents any alphanumeric character)

Response:

\n\n \n

Returns HTTP 200 on success.

\n

Extended Description

Get a CoursePlus user's details. Response includes the user's fitconnectId, first name, last name, and email.

\n\n
\n","urlObject":{"protocol":"https","path":["courseplus","user"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[{"key":"siteId","value":"{{siteId}}"},{"key":"email","value":"{{exampleEmail}}"}],"variable":[]}},"response":[],"_postman_id":"9b6b0a7e-10bf-4311-92f8-0206a025047d"},{"name":"auto-login/key","id":"4dfe236f-a2d0-45ac-be51-cb1c080e2ee0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Access-Token","value":"{{apiToken}}"},{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"text/json"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/AutoLoginKey?FitconnectID={{exampleUser}}","description":"

Get a login token.

Endpoint: /AutoLoginKey (Deprecated)

Method: GET

Parameters:

NameTypeDescription

FitConnectID

String (required)

Used as the primary identifier between systems; Format \"fcXXXXXXXXXXXX\" (where 'X' represents any alphanumeric character)

Response:

\n\n \n

Returns HTTP 200 on success.

\n

Extended Description

Produce a login key (loginKey) for a user. Response includes the login key, cache until date & time, and the expires on date & time.

Once the login key is produced for a user, it can be passed as a GET parameter to any HTTPS URL directed at our servers, and will automatically log the user in (with limited access), such as:

https://domain.com/my-education?loginKey=258E76D-67EEA0D...

\n\n
\n","urlObject":{"protocol":"https","path":["AutoLoginKey"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[{"key":"FitconnectID","value":"{{exampleUser}}"}],"variable":[]}},"response":[],"_postman_id":"4dfe236f-a2d0-45ac-be51-cb1c080e2ee0"},{"name":"courseplus/enrollment","id":"72391b3d-50f3-4bc7-80b4-4f03d090a154","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Access-Token","value":"{{apiToken}}"},{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/courseplus/enrollment?SKU={{exampleSKU}}&fitConnectID={{exampleUser}}&siteId={{siteId}}","description":"

Retrieve the user’s enrollment status for a course.

EndpointL: /courseplus/enrollment (Deprecated)

Method: GET

Parameters:

NameTypeDescription

siteId

Integer (required)

Inspire360 issued site ID

fitConnectID

String (required)

Used as the primary identifier between systems; Format \"fcXXXXXXXXXXXX\" (where 'X' represents any alphanumeric character)

SKU

String (required)

Inspire360 SKU of the product.

Response:

\n\n \n

Returns HTTP 200 on success.

\n

Returns HTTP 204 if the user is not enrolled in the specified course.

\n

Extended Description

Retrieves the user’s enrollment status for a course. Response will include the fitConnectID, SKU, CompletionDate, and Status.

Statuses include:

","urlObject":{"protocol":"https","path":["courseplus","enrollment"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[{"key":"SKU","value":"{{exampleSKU}}"},{"key":"fitConnectID","value":"{{exampleUser}}"},{"key":"siteId","value":"{{siteId}}"}],"variable":[]}},"response":[],"_postman_id":"72391b3d-50f3-4bc7-80b4-4f03d090a154"},{"name":"courseplus/enrollments","id":"ba55f7a5-776f-4a43-a15d-f364fdcfe8d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"X-Access-Token","value":"{{apiToken}}"},{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"}],"url":"https://{{subdomain}}.inspire360.{{domain}}/courseplus/enrollments?fitConnectID={{exampleUser}}&siteId={{siteId}}","description":"

Retrieve the user’s enrollment status for all courses.

EndpointL: /courseplus/enrollments (Deprecated)

Method: GET

Parameters:

NameTypeDescription

siteId

Integer (required)

Inspire360 issued site ID

fitConnectID

String (required)

Used as the primary identifier between systems; Format \"fcXXXXXXXXXXXX\" (where 'X' represents any alphanumeric character)

Response:

\n\n \n

Returns HTTP 200 on success.

\n

Extended Description

Retrieves the user’s enrollment status for a course. Response will include the fitConnectID, SKU, CompletionDate, and Status.

Statuses include:

","urlObject":{"protocol":"https","path":["courseplus","enrollments"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[{"key":"fitConnectID","value":"{{exampleUser}}"},{"key":"siteId","value":"{{siteId}}"}],"variable":[]}},"response":[],"_postman_id":"ba55f7a5-776f-4a43-a15d-f364fdcfe8d9"},{"name":"courseplus/enrollment","event":[{"listen":"test","script":{"id":"b526689a-6667-4fd5-bf81-06d69b9c18ba","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","tests[\"Response time is less than 200ms\"] = responseTime < 500;"],"type":"text/javascript"}}],"id":"5bc8b855-e545-439a-b3ba-8a9c9492c64b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"X-Access-Token","value":"{{apiToken}}"},{"key":"Content-Type","value":"text/json"},{"key":"Accept","value":"application/json"},{"key":"siteId","type":"text","value":"{{siteId}}"}],"body":{"mode":"raw","raw":"{\n \"siteId\": \"{{siteId}}\",\n \"fitconnectId\": \"{{exampleUser}}\",\n \"sku\": \"{{exampleSKU}}\",\n \"action\": \"Pass\"\n}"},"url":"https://{{subdomain}}.inspire360.{{domain}}/courseplus/enrollment","description":"

Update a user’s enrollment.

EndpointL: /courseplus/enrollment (Deprecated)

Method: PUT

Parameters:

NameTypeDescription

siteId

Integer (required)

Inspire360 issued site ID

fitConnectID

String (required)

Used as the primary identifier between systems; Format \"fcXXXXXXXXXXXX\" (where 'X' represents any alphanumeric character)

SKU

String (required)

The Inspire360 SKU of the product.

Action

String (required)

Enroll | Enable | Disable | Cancel | Pass | Fail

Response:

\n\n \n

Returns HTTP 200 on success.

\n

Extended Description

Updates a user’s enrollment status. Enrollment actions include:

","urlObject":{"protocol":"https","path":["courseplus","enrollment"],"host":["{{subdomain}}","inspire360","{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5bc8b855-e545-439a-b3ba-8a9c9492c64b"}],"event":[{"listen":"prerequest","script":{"id":"f54bc498-a043-4b21-b300-2441846d9237","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c7d5ccff-d87b-464c-8340-48ea4f96a084","type":"text/javascript","exec":[""]}}]}