{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0e6b63bf-7e5a-4757-a6d1-9aec255b99d6","name":"Powerhouse Hub v7.3+ - API Documentation","description":"<img src=\"https://content.pstmn.io/03161681-cd9a-4f67-bb31-3637631be9b3/ZmF2aWNvbi5wbmc=\" alt=\"Powerhouse%20Hub\" width=\"50\" height=\"50\">\n\n**Last updated:** 22/07/2026\n\nThis is the official API documentation for Powerhouse Hub v7.3+ - (API Version 1)\n\n# Base URL\n\nThe base URL for all API requests is:\n\n`https://your-site.powerhousehub.net/api/v1/`\n\nAlternatively, if you have a domain name active on your installation then the URL can become:\n\n`https://www.yoursite.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\n# Authentication\n\n**Authentication support depends on your site version.** API key authentication is supported on **all versions** and is the recommended method. Basic Authentication is available on **v7.3 only** and has been **removed in v8.0 and later**.\n\n| Method | v7.3 | v8.0+ | Recommended |\n| --- | --- | --- | --- |\n| API Key & Secret | Yes | Yes | Yes |\n| Basic Authentication | Yes (deprecated) | Removed | No |\n\n#### API Key & Secret **Example**:\n\nGenerate an API key and secret from within the API settings of the platform. Both the key and the secret must be sent as request headers on **every** request:\n\n```\nX-Api-Key: your-api-key\nX-Api-Secret: your-api-secret-key\n\n ```\n\nThis method works on every version and is the **only** supported method on v8.0 and later.\n\n#### Basic Authentication (v7.3 only — deprecated)\n\n**Deprecated.** Basic Authentication remains available on v7.3 for backward compatibility with existing integrations. It has been **removed in v8.0** and is not available on newer sites. New integrations, and anyone planning to upgrade to 8.0 should use API key authentication instead.\n\nOn v7.3, you can authenticate as an **Administrator** by passing a Basic Authentication header with every request:\n\n```\nAuthorization: Basic d2VsbDpkb25l\n\n ```\n\nThe encrypted text is a base64 encoded string of `username:password`.\n\n# Paginated Lists\n\nAny 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\n#### GET parameters (eg `/api/v1/listusers?page=2&limit=5`)\n\n| Param | Type | Description |\n| --- | --- | --- |\n| page | Integer | The page to display |\n| limit | Integer | The 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\n# Rate Limiting\n\nThe rate at which you can poll our API is limited to 2000 requests per hour.\n\nPlease check the response headers to help you throttle your requests:\n\n```\nX-RateLimit-Limit: 2000\nX-RateLimit-Remaining: 996\nX-RateLimit-Reset: 1572700873\n\n ```\n\n# Sending POST/PUT/DEL Requests\n\nAll POST, PUT and DEL requests must be sent with the header `Content-type: application/json` and must contain valid [JSON](https://en.wikipedia.org/wiki/JSON)\n\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\nUnfortunately, we don't support type-coercion as of yet (numbers are not converted to integers and empty strings represent a `NULL` value).\n\nImproving 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.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"23706052","team":1433622,"collectionId":"0e6b63bf-7e5a-4757-a6d1-9aec255b99d6","publishedId":"2sA35HYMEQ","public":true,"publicUrl":"https://documenter-api.postman.tech/view/23706052/2sA35HYMEQ","privateUrl":"https://go.postman.co/documentation/23706052-0e6b63bf-7e5a-4757-a6d1-9aec255b99d6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.3","publishDate":"2024-04-02T06:16:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/2cfa05e85f1c0ba62d35728b6bd3a3bc9c858132994b43bc8774aea919404d15","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sA35HYMEQ"}