API Customer Access can be enabled on the Portal Settings page. Note that “Portal Settings” access is restricted to Admins only. If you are an Admin, please follow below steps to enable API access,

  1. Once you are logged into CircleHD portal, in the top right header, there will be a user icon and a drop down arrow next to it. Click on the icon or drop down arrow to load the user options. Depending on the type of user access, you may see limited options in the drop down.
  2. Click on “Portal Settings” option in the top right drop down list under “Administration” section, this will load your portal settings page as shown below
  3. On the Portal Settings page, click “API” link in the left, under “Security Settings”. This will load the API access settings on the right.
  4. Click “Enable API Access” and click “Save” to generate API password.
  5. The password will be generate and displayed on the same page, please share the API endpoint, user and password securely to your integration team.
  6. To regenerate API key, save the API settings again.
  7. NOTE: there can be only one active API key at any given point/