Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


The API described in this guide provides programmatic-access to OpenAthens user administration and may be used to perform registration and account management operations on data held within the system. This guide does not cover all possible account operations supported by the system – it primarily covers operations related to account and organisation management.

If you are looking for documentation about connecting your local directory to OpenAthens, see: API connector

Intended Audience

This document is intended for application architects and developers.


Provides worked examples showing how the API can be used to perform common tasks. 

The API documentation is split into the following sections:

Children Display