{"info":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","description":"\"Powerhouse\n\n
\n

This is the official API documentation for Powerhouse Hub v7.1 - (API Version 1)

\n

Base URL

\n

The base URL for all API requests is:

\n

https://.powerhousehub.net/api/v1/

\n

Alternatively, if you have a domain name active on your installation then the URL can become:

\n

https://www..com/api/v1

\n
\n

We recommend not using your domain to prevent having to modify your code in the instance your domain name is changed.

\n
\n

Authentication

\n

You must authenticate as an Administrator by passing a \"Basic Authentication\" header in with every request made to the API.

\n

Example:

\n
Authorization: Basic d2VsbDpkb25l\n\n
\n

The encrypted text is a base64 encoded string of username:password.

\n
\n

Note: We do intend to support multiple client API keys with a variety of permissions as soon as possible.

\n
\n

Paginated Lists

\n

Any endpoint that returns a collection of records will be returned in a paginated list. All paginated lists support GET parameters to navigate throughout the pages and to also increase or decrease the limit of records that are returned.

\n

GET parameters (eg /api/v1/listusers?page=2&limit=5)

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamTypeDescription
pageIntegerThe page to display
limitIntegerThe total number of records to display (1-50)
\n
\n

Ordering and Filtering is not yet supported but will be added in the future in our desire to meet every RESTful API specification as well as to make life easier for those who utilise our API.

\n
\n

Rate Limiting

\n

The rate at which you can poll our API is limited to 2000 requests per hour.

\n

Please check the response headers to help you throttle your requests:

\n
X-RateLimit-Limit: 2000\nX-RateLimit-Remaining: 996\nX-RateLimit-Reset: 1572700873\n\n

Sending POST/PUT/DEL Requests

\n

All POST, PUT and DEL requests must be sent with the header Content-type: application/json and must contain valid JSON

\n

Zero Type Coercion

\n
\n

All responses are returned as strings, we apologise for any inconvenience and hope to rectify this in a future version.

\n
\n

Unfortunately, we don't support type-coercion as of yet (numbers are not converted to integers and empty strings represent a NULL value).

\n

Improving this is in our roadmap for the future but will not be introduced into this version of the API as it will not be backward compatible.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Base URL","slug":"base-url"},{"content":"Authentication","slug":"authentication"},{"content":"Paginated Lists","slug":"paginated-lists"},{"content":"Rate Limiting","slug":"rate-limiting"},{"content":"Sending POST/PUT/DEL Requests","slug":"sending-postputdel-requests"},{"content":"Zero Type Coercion","slug":"zero-type-coercion"}],"owner":"2696385","collectionId":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","publishedId":"TVKD2xUt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-09-22T05:03:11.000Z"},"item":[{"name":"User Accounts","item":[{"name":"listusers","id":"6082707d-e39d-43f0-a094-21b614ae7a3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listusers","description":"

Fetch a paginated list of registered users.

\n

Users who are currently disabled will also appear on this list. (user_status will be Disabled)

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listusers"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"51d8aad2-9b28-4270-b249-39890796a73e","name":"listusers","originalRequest":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listusers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Feb 2020 03:17:23 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"7052"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"user_id\": \"2\",\n \"user_type\": \"Admin\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"Admin\",\n \"user_lastname\": \"Admin\",\n \"user_email\": \"learner@nowhere.com\",\n \"user_login\": \"admin\",\n \"user_role\": \"Administrator\",\n \"user_phone\": \"\",\n \"user_mobile\": \"012345678\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"1482834681\"\n },\n {\n \"user_id\": \"5\",\n \"user_type\": \"Business\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"Business\",\n \"user_lastname\": \"Business\",\n \"user_email\": \"business@nowhere.com\",\n \"user_login\": \"business\",\n \"user_role\": \"Director\",\n \"user_phone\": \"asdf\",\n \"user_mobile\": \"012345678\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"1482834484\"\n },\n {\n \"user_id\": \"6\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"1580880964\"\n },\n {\n \"user_id\": \"15\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe10\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"105\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe100\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1005\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1000\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1006\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1001\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1007\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1002\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1008\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1003\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1009\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1004\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1010\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1005\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1011\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1006\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1012\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1007\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1013\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1008\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1014\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1009\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"106\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe101\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1015\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1010\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1016\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1011\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1017\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1012\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1018\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1013\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1019\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1014\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1020\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1015\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1021\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1016\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1022\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1017\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n },\n {\n \"user_id\": \"1023\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john.doe1@nowhere.com\",\n \"user_login\": \"john.doe1018\",\n \"user_role\": \"\",\n \"user_phone\": \"\",\n \"user_mobile\": \"\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_lastlogin\": \"0\"\n }\n ],\n \"error\": false,\n \"total_records\": 1869,\n \"total_pages\": 75,\n \"current_page\": 1,\n \"limit\": 25\n}"}],"_postman_id":"6082707d-e39d-43f0-a094-21b614ae7a3c"},{"name":"adduser","id":"dbd1ee43-2e4e-44d4-aae9-66a9cd16634c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_type\": \"Learner\",\n\t\"user_firstname\": \"Postman\",\n\t\"user_lastname\": \"Pat\",\n\t\"user_email\": \"pat@auspost.com.au\",\n\t\"user_login\": \"postmanpat\"\n}"},"url":"https://your-site.powerhousehub.net/api/v1/adduser","description":"

Creates a new user.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamTypeDescription
user_typeenumAdmin, Manager, Business, Learner (required)
user_firstnamestringThe user's first name (required)
user_lastnamestringThe user's last name (required)
user_emailstringThe user's email address (required)
user_loginstringThe user's preferred username which they will use to log in (required)
user_titlestringAllows any string value. E.g. Mr, Mrs, Prof, Dr etc
user_rolestringAllows any string value
user_phonestringThe user's landline phone number
user_mobilestringThe user's cellular/mobile number
user_faxstringThe user's fax number (predominantly used for Business accounts)
user_statusenumCan be one of Active or Disabled (default: Active)
user_passwordstringSpecify a password for this user (default: auto-generated)
welcome_emailboolIf true a welcome email will be sent to the provided email address containing their username and password. This is important if the user's password is auto-generated as auto-generated passwords are NOT revealed anywhere except for in this welcome email. (default: false)
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","adduser"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"beadf293-9837-42e3-a5ba-c19030f04959","name":"adduser","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_type\": \"Learner\",\n\t\"user_firstname\": \"Postman\",\n\t\"user_lastname\": \"Pat\",\n\t\"user_email\": \"pat@auspost.com.au\",\n\t\"user_login\": \"postmanpsadasat\"\n}"},"url":"https://your-site.powerhousehub.net/api/v1/adduser"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Jun 2020 15:02:49 GMT"},{"key":"Server","value":"Apache/2.4.37 (Win64) OpenSSL/1.1.1a PHP/7.3.1"},{"key":"X-Powered-By","value":"PHP/7.3.1"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"78"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"user_id\": 8,\n \"welcome_email\": \"NOT SENT\"\n },\n \"error\": false\n}"}],"_postman_id":"dbd1ee43-2e4e-44d4-aae9-66a9cd16634c"},{"name":"edituser/","id":"ef4b8b68-e568-4369-aed8-ff7b6381063d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_firstname\": \"Postman\",\n\t\"user_lastname\": \"Pat\",\n\t\"user_email\": \"pat@auspost.com.au\"\n}"},"url":"https://your-site.powerhousehub.net/api/v1/edituser/29","description":"

Allows you to modify a specific users profile.

\n
\n

Note: You cannot modify user_type once the account has already been created.

\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamTypeDescription
user_firstnamestringThe user's first name (required)
user_lastnamestringThe user's last name (required)
user_emailstringThe user's email address (required)
user_loginstringThe user's preferred username which they will use to log in (required)
user_titlestringAllows any string value. E.g. Mr, Mrs, Prof, Dr etc
user_rolestringAllows any string value
user_phonestringThe user's landline phone number
user_mobilestringThe user's cellular/mobile number
user_faxstringThe user's fax number (predominantly used for Business accounts)
user_statusenumCan be one of Active or Disabled (default: Active)
user_passwordstringModify the users password
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","edituser","29"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"ef4b8b68-e568-4369-aed8-ff7b6381063d"},{"name":"getuser/","id":"b7325413-ad9e-484e-b0ee-2806b6547b6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/getuser/3","description":"

Fetch information about a specific user

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","getuser","3"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"94fefb65-2912-468d-a066-7a7ae4ca8a7d","name":"getuser/","originalRequest":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/getuser/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jun 2020 01:23:40 GMT"},{"key":"Server","value":"Apache/2.4.37 (Win64) OpenSSL/1.1.1a PHP/7.3.1"},{"key":"X-Powered-By","value":"PHP/7.3.1"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"371"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"user_id\": \"3\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"Learner\",\n \"user_lastname\": \"Learner\",\n \"user_email\": \"learner@nowhere.com\",\n \"user_login\": \"learner\",\n \"user_role\": \"Role Assistant\",\n \"user_phone\": \"\",\n \"user_mobile\": \"012345678\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_joindate\": \"1482834681\",\n \"user_lastlogin\": \"1590627339\"\n },\n \"error\": false\n}"}],"_postman_id":"b7325413-ad9e-484e-b0ee-2806b6547b6a"},{"name":"deleteuser/","id":"40871f49-7dc0-46e5-95ec-445c312c430a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"https://your-site.powerhousehub.net/api/v1/deleteuser/14","description":"

Delete a specific user. (Not practical for data retention)

\n
\n

Tip: If you want to prevent a user from accessing the LMS, you should use the edituser endpoint and set their user_status to Disabled as deleting the user will remove their entire existence from the platform and will no longer be shown or calculated into any reports

\n
\n
\n

WARNING: Deleting a user will result in all records throughout the platform for that user to also be deleted. If you wish to retain these records than it is advised that you instead disable the user.\nThis includes:

\n
    \n
  • Course completions
    • \n
  • Training records
    • \n
  • Messenger conversations
    • \n
  • Event attendance
    • \n
  • Survey results
    • \n
  • Anything that the user has participated in
    • \n
\n

The user will effectively cease to have ever existed.

\n

Should you wish to retain this data then you should consider disabling the users account instead.

\n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","deleteuser","14"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"e83f4204-3e96-4707-9424-aefe6980b7de","name":"deleteuser/","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-site.powerhousehub.net/api/v1/deleteuser/14"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Feb 2020 04:17:26 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": null,\n \"error\": false\n}"}],"_postman_id":"40871f49-7dc0-46e5-95ec-445c312c430a"}],"id":"ff140e61-b329-48e2-a9eb-38f95d1cba5f","description":"

A collection of endpoints that allow you to create, read, update and delete users from the database.

\n","event":[{"listen":"prerequest","script":{"id":"72f7ba28-0f8b-40d4-8802-cf4259bff780","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b1e03790-d34f-4707-b25c-0ffe3b6ddf72","type":"text/javascript","exec":[""]}}],"_postman_id":"ff140e61-b329-48e2-a9eb-38f95d1cba5f","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}}},{"name":"Group Management","item":[{"name":"listgroups","id":"92c2dd0f-5157-4075-af3d-b9dac5f06014","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listgroups","description":"

Fetch a paginated list of groups.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listgroups"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"46b32fb5-d700-4cf6-837e-68162ae8db4a","name":"listgroups","originalRequest":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listgroups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Feb 2020 03:23:46 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"375"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"group_id\": \"1\",\n \"group_parent_id\": \"0\",\n \"group_title\": \"Test Group\",\n \"group_description\": \"This group is for test purposes only.\",\n \"group_key\": \"test-group\"\n },\n {\n \"group_id\": \"2\",\n \"group_parent_id\": \"1\",\n \"group_title\": \"Test Subgroup\",\n \"group_description\": \"This subgroup is for test purposes only.\",\n \"group_key\": \"test-subgroup\"\n }\n ],\n \"error\": false,\n \"total_records\": 2,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"limit\": 25\n}"}],"_postman_id":"92c2dd0f-5157-4075-af3d-b9dac5f06014"},{"name":"listusergroups/","id":"ea3e395b-15d5-4c87-9a09-696d287fc99d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listusergroups/21","description":"

Fetch a paginated list of groups that are assigned to a specific user.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listusergroups","21"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea3e395b-15d5-4c87-9a09-696d287fc99d"},{"name":"addgroup","id":"d0cd590f-8fdc-4335-b3f8-60612e839ce2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/javascript","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"group_title\": \"Test Group\",\n\t\"group_parent_id\": 0,\n\t\"group_description\": \"This is a test group created from the API\",\n\t\"group_key\": \"test-group\"\n}"},"url":"https://your-site.powerhousehub.net/api/v1/addgroup","description":"

Create a new user group.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamTypeDescription
group_titlestringThe title of the group that will appear to all users (required)
group_keystringA unique key to identify the group. (required, alphanumeric-dash, unique)
group_descriptionstringA description for this group, visible to administrators.
group_parent_idintegerAny value other than 0 (zero) will cause this group to become a sub-group of a particular parent
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","addgroup"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0cd590f-8fdc-4335-b3f8-60612e839ce2"},{"name":"editgroup/","id":"c1a0a0c9-7381-4caa-90c3-c37fdea82259","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"group_title\": \"Test Group (Edited)\",\n\t\"group_description\": \"This is a test group created from the API, and edited via the API\",\n\t\"group_key\": \"test-group-edited\"\n}"},"url":"https://your-site.powerhousehub.net/api/v1/editgroup/14","description":"

Edit an existing group.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamTypeDescription
group_titlestringThe title of the group that will appear to all users (required)
group_keystringA unique key to identify the group. (required, alphanumeric-dash, unique)
group_descriptionstringA description for this group, visible to administrators.
group_parent_idintegerAny value other than 0 (zero) will cause this group to become a sub-group of a particular parent
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","editgroup","14"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1a0a0c9-7381-4caa-90c3-c37fdea82259"},{"name":"deletegroup/","id":"38d715b3-cffb-4971-a658-e309e26f9a25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"https://your-site.powerhousehub.net/api/v1/deletegroup/3","description":"

Delete a specific group.

\n
\n

WARNING: Deleting a parent group will cause all subgroups to also be deleted, any users assigned to the group being deleted (or it's subgroups) will be unassigned.

\n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","deletegroup","3"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"07eb8ee1-5262-4420-b014-ec6b995449e7","name":"deletegroup/","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-site.powerhousehub.net/api/v1/deletegroup/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 14 Feb 2020 04:18:50 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": null,\n \"error\": false\n}"}],"_postman_id":"38d715b3-cffb-4971-a658-e309e26f9a25"},{"name":"assignusertogroup/","id":"044b697c-0d00-4066-b475-916ec82a60c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"group_id\": 3\n}"},"url":"https://your-site.powerhousehub.net/api/v1/assignusertogroup/29","description":"

Assign a user to a group

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamTypeDescription
group_idintegerThe group that the user will be assigned to (required)
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","assignusertogroup","29"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"044b697c-0d00-4066-b475-916ec82a60c9"},{"name":"unassignuserfromgroup/","id":"e88f4c5d-f49c-4f9b-98fc-fd65ac745465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"group_id\": 3\n}"},"url":"https://your-site.powerhousehub.net/api/v1/unassignuserfromgroup/29","description":"

Unassign a user from a group.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamTypeDescription
group_idintegerThe group that the user will be unassigned from (required)
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","unassignuserfromgroup","29"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"d7b147cd-97ee-4e17-8e72-16b7f640b187","name":"unassignuserfromgroup/","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"group_id\": 3\n}","options":{"raw":{"language":"json"}}},"url":"https://your-site.powerhousehub.net/api/v1/unassignuserfromgroup/29"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Feb 2020 00:39:42 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": null,\n \"error\": false\n}"}],"_postman_id":"e88f4c5d-f49c-4f9b-98fc-fd65ac745465"}],"id":"4e49352e-b24d-4d55-8e58-a3fbd052642e","description":"

A collection of endpoints that allow you to control Groups within the platform.

\n","_postman_id":"4e49352e-b24d-4d55-8e58-a3fbd052642e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}}},{"name":"Courses","item":[{"name":"listcourses","id":"83f234e4-cdb0-488e-85ce-81a3016745a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listcourses","description":"

Fetch a paginated list of courses.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listcourses"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"83f234e4-cdb0-488e-85ce-81a3016745a0"},{"name":"listcoursesstartedsince","id":"f1b8c521-d82f-4845-a459-1a8bc75211ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listcoursesstartedsince?date=2019-01-01T10:11:44+00:00","description":"

Fetch a paginated list of courses.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listcoursesstartedsince"],"host":["https://your-site.powerhousehub.net"],"query":[{"description":{"content":"

A valid RFC-3339 date is required

\n","type":"text/plain"},"key":"date","value":"2019-01-01T10:11:44+00:00"}],"variable":[]}},"response":[{"id":"6c43af52-6be0-40dc-b16e-ffc14ad71ee5","name":"listcoursesstartedsince","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your-site.powerhousehub.net/api/v1/listcoursesstartedsince?date=2019-01-01T10:11:44+00:00","host":["https://your-site.powerhousehub.net"],"path":["api","v1","listcoursesstartedsince"],"query":[{"key":"date","value":"2019-01-01T10:11:44+00:00","description":"A valid RFC-3339 date is required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jun 2020 11:13:50 GMT"},{"key":"Server","value":"Apache/2.4.37 (Win64) OpenSSL/1.1.1a PHP/7.3.1"},{"key":"X-Powered-By","value":"PHP/7.3.1"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"5161"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"course_id\": \"18\",\n \"course_title\": \"Course Test 1\",\n \"course_isactive\": \"Published\",\n \"course_isarchived\": \"N\",\n \"user_id\": \"61402\",\n \"course_datecompleted\": \"1569487431\",\n \"course_completed_status\": \"Passed\"\n },\n {\n \"course_id\": \"173\",\n \"course_title\": \"Course Test 2\",\n \"course_isactive\": \"Published\",\n \"course_isarchived\": \"N\",\n \"user_id\": \"52223\",\n \"course_datecompleted\": \"0\",\n \"course_completed_status\": \"Incomplete\"\n }\n ],\n \"error\": false,\n \"total_records\": 2,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"limit\": 25\n}"}],"_postman_id":"f1b8c521-d82f-4845-a459-1a8bc75211ad"},{"name":"listcoursescompletedsince","id":"1442e7ef-4cba-49d7-9489-73cac2f7ac27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listcoursescompletedsince?date=2019-01-01T10:11:44+00:00","description":"

Fetch a paginated list of courses.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listcoursescompletedsince"],"host":["https://your-site.powerhousehub.net"],"query":[{"description":{"content":"

A valid RFC-3339 date is required

\n","type":"text/plain"},"key":"date","value":"2019-01-01T10:11:44+00:00"}],"variable":[]}},"response":[{"id":"215f4e8b-f39d-4123-85be-dac5978e95d1","name":"listcoursescompletedsince","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your-site.powerhousehub.net/api/v1/listcoursescompletedsince?date=2019-01-01T10:11:44+00:00","host":["https://your-site.powerhousehub.net"],"path":["api","v1","listcoursescompletedsince"],"query":[{"key":"date","value":"2019-01-01T10:11:44+00:00","description":"A valid RFC-3339 date is required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jun 2020 11:11:30 GMT"},{"key":"Server","value":"Apache/2.4.37 (Win64) OpenSSL/1.1.1a PHP/7.3.1"},{"key":"X-Powered-By","value":"PHP/7.3.1"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"5334"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"course_id\": \"143\",\n \"course_title\": \"Course Test 1\",\n \"course_isactive\": \"Published\",\n \"course_isarchived\": \"N\",\n \"user_id\": \"39629\",\n \"course_datecompleted\": \"1547212014\",\n \"course_completed_status\": \"Incomplete\"\n },\n {\n \"course_id\": \"144\",\n \"course_title\": \"Course Test 1\",\n \"course_isactive\": \"Published\",\n \"course_isarchived\": \"N\",\n \"user_id\": \"39629\",\n \"course_datecompleted\": \"1547212105\",\n \"course_completed_status\": \"Incomplete\"\n }\n ],\n \"error\": false,\n \"total_records\": 2,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"limit\": 25\n}"}],"_postman_id":"1442e7ef-4cba-49d7-9489-73cac2f7ac27"},{"name":"listusercourses/","id":"1657278c-5b1d-4215-9bce-a9e18a43440e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listusercourses/3","description":"

Fetch a paginated list of courses that are assigned to a specific user.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listusercourses","3"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"1657278c-5b1d-4215-9bce-a9e18a43440e"},{"name":"listcourseusers/","id":"cb66ff76-7aef-4daa-a24f-61f42dde8b68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listcourseusers/3","description":"

Fetch a paginated list of users that are assigned to a specific course either via group assignment or directly

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listcourseusers","3"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"d08ded10-576f-4060-8179-c5189bc1629d","name":"listcourseusers/","originalRequest":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listcourseusers/3"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 29 Jun 2020 03:05:31 GMT"},{"key":"Server","value":"Apache/2.4.37 (Win64) OpenSSL/1.1.1a PHP/7.3.1"},{"key":"X-Powered-By","value":"PHP/7.3.1"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"435"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"user_id\": \"3\",\n \"user_type\": \"Learner\",\n \"user_title\": \"Mr\",\n \"user_firstname\": \"Learner\",\n \"user_lastname\": \"Learner\",\n \"user_email\": \"learner@nowhere.com\",\n \"user_login\": \"learner\",\n \"user_role\": \"Role Assistant\",\n \"user_phone\": \"\",\n \"user_mobile\": \"012345678\",\n \"user_fax\": \"\",\n \"user_status\": \"Active\",\n \"user_joindate\": \"1482834681\",\n \"user_lastlogin\": \"1590627339\"\n }\n ],\n \"error\": false,\n \"total_records\": 1,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"limit\": 25\n}"}],"_postman_id":"cb66ff76-7aef-4daa-a24f-61f42dde8b68"},{"name":"listusercourseprogress/","id":"3a21801c-9ca5-471c-930d-cbcfa7353686","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listusercourseprogress/3","description":"

Fetch a paginated list of courses that a user has commenced some sort of activity in.

\n

The list will contain both completed, and incompleted courses. To get a list of completed courses only you can add a query parameter: ?completed=1

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listusercourseprogress","3"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"173009e3-3f79-42c0-8785-4d725c7d6b5d","name":"listusercourseprogress/?completed=1","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your-site.powerhousehub.net/api/v1/listusercourseprogress/7?completed=1","host":["https://your-site.powerhousehub.net"],"path":["api","v1","listusercourseprogress","7"],"query":[{"key":"completed","value":"1","description":"Only show courses that have been completed"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Feb 2020 01:45:42 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1138"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"course_id\": \"1\",\n \"course_title\": \"The importance of a well-written email\",\n \"course_status\": \"Passed\",\n \"course_current_progress\": \"100\",\n \"course_datestarted\": \"1580864355\",\n \"course_datelastattempted\": \"1580864355\",\n \"course_datecompleted\": \"1564966755\",\n \"course_isactive\": \"Published\"\n },\n {\n \"course_id\": \"3\",\n \"course_title\": \"Safety Lights\",\n \"course_status\": \"Passed\",\n \"course_current_progress\": \"100\",\n \"course_datestarted\": \"1580864363\",\n \"course_datelastattempted\": \"1580864363\",\n \"course_datecompleted\": \"1572915563\",\n \"course_isactive\": \"Published\"\n },\n {\n \"course_id\": \"4\",\n \"course_title\": \"Emergency Exits\",\n \"course_status\": \"Passed\",\n \"course_current_progress\": \"100\",\n \"course_datestarted\": \"1580864367\",\n \"course_datelastattempted\": \"1580864367\",\n \"course_datecompleted\": \"1567645167\",\n \"course_isactive\": \"Published\"\n },\n {\n \"course_id\": \"5\",\n \"course_title\": \"Fire Extinguishers - Knowing your flame\",\n \"course_status\": \"Passed\",\n \"course_current_progress\": \"100\",\n \"course_datestarted\": \"1580864372\",\n \"course_datelastattempted\": \"1580864372\",\n \"course_datecompleted\": \"1567645172\",\n \"course_isactive\": \"Published\"\n }\n ],\n \"error\": false,\n \"total_records\": 4,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"limit\": 25\n}"},{"id":"82e85dc2-8b79-4ccf-b9f6-51fd123c7598","name":"listusercourseprogress/","originalRequest":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listusercourseprogress/7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 21 Feb 2020 01:43:34 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1384"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"course_id\": \"1\",\n \"course_title\": \"The importance of a well-written email\",\n \"course_status\": \"Passed\",\n \"course_current_progress\": \"100\",\n \"course_datestarted\": \"1580864355\",\n \"course_datelastattempted\": \"1580864355\",\n \"course_datecompleted\": \"1564966755\",\n \"course_isactive\": \"Published\"\n },\n {\n \"course_id\": \"2\",\n \"course_title\": \"Safe use of Ladders\",\n \"course_status\": \"Incomplete\",\n \"course_current_progress\": \"85\",\n \"course_datestarted\": \"1580864360\",\n \"course_datelastattempted\": \"1580864360\",\n \"course_datecompleted\": \"0\",\n \"course_isactive\": \"Published\"\n },\n {\n \"course_id\": \"3\",\n \"course_title\": \"Safety Lights\",\n \"course_status\": \"Passed\",\n \"course_current_progress\": \"100\",\n \"course_datestarted\": \"1580864363\",\n \"course_datelastattempted\": \"1580864363\",\n \"course_datecompleted\": \"1572915563\",\n \"course_isactive\": \"Published\"\n },\n {\n \"course_id\": \"4\",\n \"course_title\": \"Emergency Exits\",\n \"course_status\": \"Passed\",\n \"course_current_progress\": \"100\",\n \"course_datestarted\": \"1580864367\",\n \"course_datelastattempted\": \"1580864367\",\n \"course_datecompleted\": \"1567645167\",\n \"course_isactive\": \"Published\"\n },\n {\n \"course_id\": \"5\",\n \"course_title\": \"Fire Extinguishers - Knowing your flame\",\n \"course_status\": \"Passed\",\n \"course_current_progress\": \"100\",\n \"course_datestarted\": \"1580864372\",\n \"course_datelastattempted\": \"1580864372\",\n \"course_datecompleted\": \"1567645172\",\n \"course_isactive\": \"Published\"\n }\n ],\n \"error\": false,\n \"total_records\": 5,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"limit\": 25\n}"}],"_postman_id":"3a21801c-9ca5-471c-930d-cbcfa7353686"},{"name":"assigncoursetogroup/","id":"cb05cf72-f387-4440-9ec9-247c37bfe9ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"group_id\": 3\n}"},"url":"https://your-site.powerhousehub.net/api/v1/assigncoursetogroup/29","description":"

Assign a course to a group. This will allow any users of the provided group to access the course immediately provided that the course has been published.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamTypeDescription
group_idintegerThe group that the course will be assigned to (required)
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","assigncoursetogroup","29"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb05cf72-f387-4440-9ec9-247c37bfe9ea"},{"name":"unassigncoursefromgroup/","id":"d778ef5f-361b-4c3a-8ab6-20c516240989","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/javascript","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"group_id\": 3\n}"},"url":"https://your-site.powerhousehub.net/api/v1/assigncoursetogroup/29","description":"

Unassign a course from a group. Users of this group will no longer be able to access the given course, regardless of whether or not they have completed it or started it.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamTypeDescription
group_idintegerThe group that the course will be unassigned from (required)
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","assigncoursetogroup","29"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"d778ef5f-361b-4c3a-8ab6-20c516240989"}],"id":"95862cda-8ece-471d-af50-25623b0f9a5e","description":"

A collection of courses that allow you to control some aspects of Courses on the platform.

\n

ROADMAP

\n
    \n
  • Allow courses to be published/unpublished
    • \n
  • Allow course settings to be modified
    • \n
\n","_postman_id":"95862cda-8ece-471d-af50-25623b0f9a5e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}}},{"name":"Onboarding","item":[{"name":"listworkflows","id":"4fbacbcb-4fd9-49dc-a328-9d6ca95cdc23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listworkflows","description":"

Fetch a paginated list of Onboarding Workflows that are currently configured on the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listworkflows"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"c3457db6-dfc6-460d-b3cc-4974477c0d4f","name":"listworkflows","originalRequest":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listworkflows"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Mar 2020 05:57:05 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"467"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"workflow_id\": \"1\",\n \"workflow_title\": \"Onboarding Induction\",\n \"workflow_status\": \"Active\",\n \"workflow_timeframe\": \"0\",\n \"workflow_timeframe_enabled\": \"0\",\n \"workflow_email_settings\": \"\",\n \"workflow_create_learner_enabled\": \"0\",\n \"workflow_cert_id\": \"0\",\n \"workflow_reminder_enabled\": \"0\",\n \"workflow_reminder_email_1w\": \"0\",\n \"workflow_reminder_email_1d\": \"0\",\n \"workflow_reminder_email_0d\": \"0\"\n }\n ],\n \"error\": false,\n \"total_records\": 1,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"limit\": 25\n}"}],"_postman_id":"4fbacbcb-4fd9-49dc-a328-9d6ca95cdc23"},{"name":"listworkflowusers/","id":"56c7c05d-7c1c-493e-ae3b-d256fcab7eaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listworkflowusers/1","description":"

Fetch a paginated list of users that are assigned to a particular workflow

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","listworkflowusers","1"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"1fe8bee3-bb81-41a1-a43c-23b45cff0640","name":"listworkflowusers/","originalRequest":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/listworkflowusers/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Mar 2020 05:57:09 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1014"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"workflow_id\": \"1\",\n \"user_id\": \"1872\",\n \"user_firstname\": \"Reece\",\n \"user_lastname\": \"Alexander\",\n \"user_email\": \"no_user_here@powerhousehub.com\",\n \"workflow_dateassigned\": \"1583123659\",\n \"workflow_dateexpiry\": \"0\",\n \"workflow_datelastviewed\": \"0\",\n \"workflow_datecompleted\": \"0\",\n \"workflow_status\": \"Pending\"\n },\n {\n \"workflow_id\": \"1\",\n \"user_id\": \"1873\",\n \"user_firstname\": \"John\",\n \"user_lastname\": \"Doe\",\n \"user_email\": \"john@doe.com\",\n \"workflow_dateassigned\": \"1583127058\",\n \"workflow_dateexpiry\": \"0\",\n \"workflow_datelastviewed\": \"0\",\n \"workflow_datecompleted\": \"0\",\n \"workflow_status\": \"Pending\"\n },\n {\n \"workflow_id\": \"1\",\n \"user_id\": \"1874\",\n \"user_firstname\": \"Bob\",\n \"user_lastname\": \"Jane\",\n \"user_email\": \"bob@bobjane.com.au\",\n \"workflow_dateassigned\": \"1583128338\",\n \"workflow_dateexpiry\": \"0\",\n \"workflow_datelastviewed\": \"0\",\n \"workflow_datecompleted\": \"0\",\n \"workflow_status\": \"Pending\"\n }\n ],\n \"error\": false,\n \"total_records\": 3,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"limit\": 25\n}"}],"_postman_id":"56c7c05d-7c1c-493e-ae3b-d256fcab7eaa"},{"name":"assignworkflowtogroup/","id":"6665a9dc-b7c3-4a1b-bb3d-507229e4b20b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_firstname\": \"Testing\",\n\t\"user_lastname\": \"Guy\",\n\t\"user_email\": \"no_such_user@here.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-site.powerhousehub.net/api/v1/assignusertoworkflow/1","description":"

Assign a user to a particular workflow.

\n
\n

Warning: This method is not available in future versions of the LMS as workflows are assigned via group instead.

\n
\n
\n

Note: Given the semantics around the term \"Onboarding\"; assigning a \"user\" to a workflow effectively creates a new Onboarding account, you cannot invite existing users of any type to a workflow as they are assumed to have already been \"onboarded\" in some way.

\n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","assignusertoworkflow","1"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[],"_postman_id":"6665a9dc-b7c3-4a1b-bb3d-507229e4b20b"},{"name":"unassignworkflowgroup/","id":"2b49ede3-bbbb-4b0f-99f4-d6c66c626767","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"user_id\": 123\n}","options":{"raw":{"language":"json"}}},"url":"https://your-site.powerhousehub.net/api/v1/unassignuserfromworkflow/1","description":"
\n

Warning: This method is not available in future versions of the LMS as workflows are assigned via group instead.

\n
\n

Unassigns a user from a workflow and discards their temporary Onboarding account.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","unassignuserfromworkflow","1"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"f6099467-76f7-4232-9507-44222c1bf257","name":"unassignuserfromworkflow/","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"user_id\": 123\n}","options":{"raw":{"language":"json"}}},"url":"https://your-site.powerhousehub.net/api/v1/unassignuserfromworkflow/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Mar 2020 05:55:45 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": null,\n \"error\": false\n}"}],"_postman_id":"2b49ede3-bbbb-4b0f-99f4-d6c66c626767"}],"id":"55e0b18f-935f-44ff-8ade-17d362a7f7a6","description":"

Using these endpoints, you can collect a list of Onboarding Workflows, assign users to those workflows as well as unassign users from those workflows.

\n

Given the complexity of the workflows; you can only create and edit workflows from within the Administration Portal directly.

\n
\n

Note: Given the semantics around the term \"Onboarding\"; assigning a \"user\" to a workflow effectively creates a new Onboarding account, you cannot invite existing users of any type to a workflow as they are assumed to have already been \"onboarded\" in some way.

\n
\n","_postman_id":"55e0b18f-935f-44ff-8ade-17d362a7f7a6","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}}},{"name":"Training Records","item":[{"name":"addtraining","id":"2c0c83f9-bb6b-4285-a840-feb002a006f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"user_id\": 8,\n\t\"trainingrecord_cdate\": 1611550671,\n\t\"trainingrecord_activity\": \"My External Training\",\n\t\"trainingrecord_filename\": \"hello-world.txt\",\n \"trainingrecord_filebody\": \"SGVsbG8gV29ybGQhIFRoYW5rIHlvdSBmb3IgdGFraW5nIHRoZSB0aW1lIHRvIGRlY29kZSB0aGlzIG1lc3NhZ2UsIHZlcnkgdGhvcm91Z2guLi4=\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-site.powerhousehub.net/api/v1/addtraining","description":"

Add external training records to a specific user.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParamTypeDescription
user_idintegerThe ID of the user whom you are adding a training record for
trainingrecord_cdateintegerA UNIX timestamp representing the actual completion date of the training
trainingrecord_activitystringA title for the training record
trainingrecord_filenameintegerTraining records require documentation. Please provide the filename (including extension) of the documentation you are providing
trainingrecord_filebodystringThe raw contents of the documentation encoded with Base64
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","addtraining"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"db2dcd09-cc6d-4e1d-8fce-9b41409cdd48","name":"addtraining","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/javascript"}],"body":{"mode":"raw","raw":"{\n\t\"user_id\": 8,\n\t\"trainingrecord_cdate\": 1611550671,\n\t\"trainingrecord_activity\": \"My External Training\",\n\t\"trainingrecord_filename\": \"hello-world.txt\",\n \"trainingrecord_filebody\": \"SGVsbG8gV29ybGQhIFRoYW5rIHlvdSBmb3IgdGFraW5nIHRoZSB0aW1lIHRvIGRlY29kZSB0aGlzIG1lc3NhZ2UsIHZlcnkgdGhvcm91Z2guLi4=\"\n}"},"url":"https://your-site.powerhousehub.net/api/v1/addtraining"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Jan 2021 05:13:53 GMT"},{"key":"Server","value":"Apache/2.4.39 (Win64) PHP/7.3.5"},{"key":"X-Powered-By","value":"PHP/7.3.5"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"61"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"trainingrecord_id\": 1\n },\n \"error\": false\n}"}],"_postman_id":"2c0c83f9-bb6b-4285-a840-feb002a006f4"}],"id":"65bb33b4-1d42-4b60-b0b7-f41611e4c296","_postman_id":"65bb33b4-1d42-4b60-b0b7-f41611e4c296","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}}},{"name":"Platform","item":[{"name":"getversion","id":"8ac061c9-23aa-48ea-85a4-1f174567c4ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/getversion","description":"

Get the currently operating core version

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","getversion"],"host":["https://your-site.powerhousehub.net"],"query":[],"variable":[]}},"response":[{"id":"eb85166a-519d-4c64-9164-fa7b189c04f5","name":"Version","originalRequest":{"method":"GET","header":[],"url":"https://your-site.powerhousehub.net/api/v1/getversion"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 02 Jun 2020 10:44:34 GMT"},{"key":"Server","value":"Apache/2.4.37 (Win64) OpenSSL/1.1.1a PHP/7.3.1"},{"key":"X-Powered-By","value":"PHP/7.3.1"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"55"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"version\": \"7.0\"\n },\n \"error\": false\n}"}],"_postman_id":"8ac061c9-23aa-48ea-85a4-1f174567c4ce"}],"id":"e03caa88-d725-4f55-b4ab-2ec43963fc25","event":[{"listen":"prerequest","script":{"id":"35907e36-59f4-4261-b306-666841e190f6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4ef54661-bc1a-43b9-bece-08928e76ca88","type":"text/javascript","exec":[""]}}],"_postman_id":"e03caa88-d725-4f55-b4ab-2ec43963fc25","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]},"isInherited":true,"source":{"_postman_id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","id":"2f4ffaaf-87ce-4d0a-9b37-3ba8bcccbe7a","name":"Powerhouse Hub v7.1+ - API Documentation","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"username"},{"key":"password","value":"password"}]}},"event":[{"listen":"prerequest","script":{"id":"da7eba8b-453d-4531-901f-d8f15dc09d23","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4cc5df24-5597-4cb0-bc7d-56ca30a18465","type":"text/javascript","exec":[""]}}],"variable":[{"key":"SERVER_URL","value":"https://your-site.powerhousehub.net"},{"key":"USERNAME","value":"username"},{"key":"PASSWORD","value":"password"}]}