Requesting Alma API keys

Requesting Alma API keys

Alma provides the ability to access data via API calls, using scripts or tools like Postman.

We have a daily limit of API calls for all work done by the libraries, which includes requesting items, accessioning and managing records between CAIASoft and Alma, printing spine labels, and other workflows.

Because we do not have unlimited API access, we are being cautious in distributing API keys beyond those needed for core library workflows until we have a better understanding of how our transactions are counted.

If an API key is needed for a workflow, please open a support ticket via https://support.lib.duke.edu and assign it to the Alma queue.

You must include the following:

  • A description of the project or integration that you need the key for;

  • Whether you need a key/keys for Alma production, Alma premium sandbox, or both;

  • What areas of Alma the keys need access to, and whether the access should be read-only, or read/write.

Keys will be distributed using 1Password vaults. If you do not have a 1Password account (via OIT), you will be asked to create one.


Note that read/write access to the Configuration API will generally not be granted.

If you have an application that requires that access, please be sure to include a full explanation in the support ticket for LSIS review.