{"_id":"5515ad8807e9252f003489a5","category":{"_id":"5515ad7607e9252f003489a4","project":"54b95c11d48fef1e007b81d8","version":"54b95ccdc91cc30c00cc496d","__v":8,"pages":["5515ad8807e9252f003489a5","5515ad917b27cc2d00470dba","5515ad9b7b27cc2d00470dbc","551adfdc9f4aa535006534c7","551dfc45e52a0b23000c62b8","551dfe11e52a0b23000c62bc","551e06a3a7e98017009e3ee7","56c4b1b9116c0d21000bcf40"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-27T19:20:22.192Z","from_sync":false,"order":11,"slug":"api-services","title":"API Services"},"user":"54b95be3c91cc30c00cc496c","project":"54b95c11d48fef1e007b81d8","__v":21,"version":{"_id":"54b95ccdc91cc30c00cc496d","__v":18,"forked_from":"54b95c11d48fef1e007b81db","project":"54b95c11d48fef1e007b81d8","createdAt":"2015-01-16T18:47:41.803Z","releaseDate":"2015-01-16T18:47:41.803Z","categories":["54b95ccec91cc30c00cc496e","551482cefd6a440d0064c0c4","551486dbfd6a440d0064c0d2","551486ecbc466623002afd74","551486f50a0c69170061686a","551487a20bc2c53900e29aba","551488a0fd6a440d0064c0db","551488f7bc466623002afd7f","55148cb80a0c691700616879","5515ad7607e9252f003489a4","553695d76fd3c40d00334956","553696796fd3c40d00334957","553696a76a63520d00ae6159","553697097f093f0d009fd4ef","5536971b4636ed0d00ebb6d4","5536972b6a63520d00ae615b","553697344636ed0d00ebb6d5","553a7a959a32920d008670f2"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"7.0.0","version":"7"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-03-27T19:20:40.113Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"text","name":"","code":""},{"code":"","language":"text"}]},"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"You can skip to a detailed description of the API and its usage, as well as a developer console.  [Go to the developer console](https://api.grouphigh.com/raml-api-console/?raml=https://api.grouphigh.com/v3/raml/public/v3/app.raml)\",\n  \"title\": \"Already have API access?\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting Started\"\n}\n[/block]\nTo get started, you will need a GroupHigh account with permissions for API access.  API access is typically purchased as an add-on to your GroupHigh license.  To verify API access, login to the GroupHigh application, and click on your email in the upper-right, then 'Your Settings'.  Using the menu on the left navigate to API Access.  You will see a green dot and related message if your account has api access.  If you would like to know more about API access email support:::at:::grouphigh.com.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What data is available?\"\n}\n[/block]\nMost API users integrate List and Tracker-related data into custom applications and dashboards.  However, all of the data you can access via our application is accessible via the API.  For more information head to the development console.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Security\"\n}\n[/block]\nWe use Basic Authentication to provide api access.  The same username and password that you use to access the GroupHigh application can access the API if you have the proper permission.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"F.A.Q.\"\n}\n[/block]\n**Where do I find the id_activity parameter?**\n\nThe *id_activity* is the last alphanumeric token in the url displayed in the browser.  Check out the \"Finding the *id_activity* image below.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/hbRGCI5fT6OH1g1jcxQg_Capture.PNG\",\n        \"Capture.PNG\",\n        \"1143\",\n        \"491\",\n        \"\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Developer Console\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Ready to begin?\",\n  \"body\": \"[Go to the developer console](https://api.grouphigh.com/raml-api-console/?raml=https://api.grouphigh.com/v3/raml/public/v3/app.raml)\"\n}\n[/block]","excerpt":"GroupHigh provides an API to access all of your account's information.  This is great for adding data to client-facing dashboards and/or anytime there is a need to customize the data displayed.","slug":"api-account","type":"basic","title":"Account API"}

Account API

GroupHigh provides an API to access all of your account's information. This is great for adding data to client-facing dashboards and/or anytime there is a need to customize the data displayed.

[block:callout] { "type": "info", "body": "You can skip to a detailed description of the API and its usage, as well as a developer console. [Go to the developer console](https://api.grouphigh.com/raml-api-console/?raml=https://api.grouphigh.com/v3/raml/public/v3/app.raml)", "title": "Already have API access?" } [/block] [block:api-header] { "type": "basic", "title": "Getting Started" } [/block] To get started, you will need a GroupHigh account with permissions for API access. API access is typically purchased as an add-on to your GroupHigh license. To verify API access, login to the GroupHigh application, and click on your email in the upper-right, then 'Your Settings'. Using the menu on the left navigate to API Access. You will see a green dot and related message if your account has api access. If you would like to know more about API access email support@grouphigh.com. [block:api-header] { "type": "basic", "title": "What data is available?" } [/block] Most API users integrate List and Tracker-related data into custom applications and dashboards. However, all of the data you can access via our application is accessible via the API. For more information head to the development console. [block:api-header] { "type": "basic", "title": "Security" } [/block] We use Basic Authentication to provide api access. The same username and password that you use to access the GroupHigh application can access the API if you have the proper permission. [block:api-header] { "type": "basic", "title": "F.A.Q." } [/block] **Where do I find the id_activity parameter?** The *id_activity* is the last alphanumeric token in the url displayed in the browser. Check out the "Finding the *id_activity* image below. [block:image] { "images": [ { "image": [ "https://files.readme.io/hbRGCI5fT6OH1g1jcxQg_Capture.PNG", "Capture.PNG", "1143", "491", "", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "Developer Console" } [/block] [block:callout] { "type": "success", "title": "Ready to begin?", "body": "[Go to the developer console](https://api.grouphigh.com/raml-api-console/?raml=https://api.grouphigh.com/v3/raml/public/v3/app.raml)" } [/block]