CollectiveAccess offers several web-based APIs for data access and manipulation:

  • GraphQL

  • Simple

  • JSON

  • IIIF


Two are general-use APIs, providing access to much of CollectiveAccess’ functionality including data access and editing, search and configuration.

General-Use APIs

  • GraphQL API: A GraphQL-based API first offered in CollectiveAccess version 1.8. This API provides a full range of services for reading and writing both catalogue data and system configuration, and is under active development.

  • JSON API (Legacy): A REST-style API returning JSON-encoded payloads for read and write operations. Available since version 1.3, this API is deprecated and will be removed in a future release. We recommend avoiding use of this API for new projects.

APIs Providing More Specialized Access: