Access HCMS API Documentation

This article will show you how to access the API documentation for your HCMS.

Important Note

Only users in a group with owner or developer access will see the API option in the navigation panel. You can also create custom roles with API access if desired.

Who can use this feature?

Owner | Developer  

Instructions

1. Sign in to the HCMS

2. Click API on the left-hand side

3. Select Content API to open a tab with documentation specific to your HCMS content

   Note:

   This is API documentation for each of the content types for this HCMS application. As content types are added and modified, this API documentation will be dynamically and immediately updated to reflect any additions and changes.

4. Select General API to open a tab with general API documentation

   Note:

   This is general API documentation that is updated and maintained by CivicPlus and applies to all HCMS applications.