Publisher API
Overview

OVERVIEW


With the release of HighQ Publisher 4.6.0, we are starting to roll out a brand new API framework. The release of these APIs is a result of a strong focus within HighQ on interoperability between Publisher, Collaborate, and our existing partner connectors.

Our primary focus for this release has been around exposing user, group and organisation management via APIs to allow external management of these features, and as groundwork to enable our future user, organisation & profile sync tool. Over the next few product releases we will continue to expand the APIs to allow even more integration with your external systems and purpose build applications.

 

Version history & API improvements

Publisher 4.6  - Jan 2018

User, Group and Organisation APIs

Publisher 4.7 - Jul 2018

People Directory APIs

HighQ 5.0 - Dec 2018

Search APIs, improved User, Group and Organisation APIs

HighQ 5.1 - May 2019

Metadata, Content list, Dashboard list, Document list, Image list, System Page list APIs

HighQ 5.2 - due Q3/Q4 2019

Adding Swagger support for Publisher APIs (Raise a support ticket to get this enabled)

 


General    

Revoke token

HTTP Response codes

HTTP Request headers

API Error messages

User APIs    

Get User

Get User list

Add User

Add User profile image

Update User

Archive User

Activate User

Disable User

Get User System Preferences

Update User System Preferences

Get User Email Preferences

Update User Email Preferences

Bulk User Activate

Bulk User Archive

Bulk User Disable

Assign / Revoke System Admin permissions

Assign / Revoke Key Contact

Reinstate User

User Group APIs    

Get User Group

Get User Group list

Add User Group

Update User Group

Delete User Group

Add Users to User Group

Organisation APIs    

Get Organisation

Get Organisation list

Add Organisation

Update Organisation

Archive Organisation

Activate Organisation

Disable Organisation

Get Organisation Email Preferences

Update Organisation Email Preferences

Add Organisation Domain

Update Organisation Domain

Move Organisation Domain

Update Organisation Domain

Move Organisation Domain

Get Organisation Domain

Get Organisation Domain list

Bulk Activate Organisation

Bulk Archive Organisation

Bulk Disable Organisation

Search APIs    

Get Search Results

Get search content type facet list

Get Search Results Count

Exception Domain APIs    

Get Exception Domain

Get Exception Domain List

Add Exception Domain

Update Exception Domain

Activate Exception Domain

Archive Exception Domain

Pending Exception Domain

Metadata APIs    

Get Metadata Node

Get Metadata Node List

Add Metadata Node

Update Metadata Node

Delete Metadata Node

Archive Metadata Node

Activate Metadata Node

Add 1st Level Metadata Category

Update 1st Level Metadata Category

Delete 1st Level Metadata Category

Add 2nd Level Metadata Label

Update 2nd Level Metadata Label

Delete 2nd Level Metadata Label

People Directory APIs    

Get People Directory people list

Get People Directory filters

Get People Directory configuration

Content APIs    

Get Content List

Dashboard APIs    

Get Dashboard List

System Page APIs    

Get System Pages List

Document APIs    

Get Document List

Image APIs    

Get Image List

Getting Started

Comments


5 Comments

Last Updated: Sep 22,2023