Ex Libris

Ex Libris Almaws API

The Almaws API from Ex Libris — 12 operation(s) for almaws.

Documentation GitHub OpenAPI

Operations 25

GET /almaws/v1/courses Retrieve Courses #

POST /almaws/v1/courses Add a new Course #

DELETE /almaws/v1/courses/{courseId} Remove Course #

GET /almaws/v1/courses/{courseId} Retrieve Course #

POST /almaws/v1/courses/{courseId} Enroll to course #

PUT /almaws/v1/courses/{courseId} Update Course #

DELETE /almaws/v1/courses/{courseId}/lists/{listId} Delete Course Enrollment #

POST /almaws/v1/courses/{courseId}/reading-lists Create a Reading List #

DELETE /almaws/v1/courses/{courseId}/reading-lists/{readingListId} Remove Reading List #

GET /almaws/v1/courses/{courseId}/reading-lists/{readingListId} Retrieve a Reading List #

PUT /almaws/v1/courses/{courseId}/reading-lists/{readingListId} Update a Reading List #

DELETE /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/citations/{citationId} Remove Citation #

GET /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/citations/{citationId} Retrieve Citation #

POST /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/citations/{citationId} Remove file from citation #

PUT /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/citations/{citationId} Update Citation #

GET /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/citations/{citationId}/tags Retrieves Tags #

PUT /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/citations/{citationId}/tags Update Tags #

DELETE /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/owners/{primaryId} Delete Owner #

GET /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/owners/{primaryId} Retrieve Owner #

PUT /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/owners/{primaryId} Update Owner #

GET /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/{id} Retrieve Citations #

POST /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/{id} Create Citation #

DELETE /almaws/v1/courses/{courseId}/users/{userId} Delete Course Enrollment #

GET /almaws/v1/courses/{courseId}/{id} Retrieve Reading Lists #

GET /almaws/version/resource-name/parameters GET /almaws/version/resource-name/parameters #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/ex-libris:ex-libris-almaws-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Ex Libris Almaws API
  version: '2026-10-13'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 44 operation(s) read from 8 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Ex Libris has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 42
    pages-with-code: 3
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-13'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developers.exlibrisgroup.com/alma/apis
  - https://developers.exlibrisgroup.com/primo/apis
  - https://developers.exlibrisgroup.com/esploro/apis
  - https://developers.exlibrisgroup.com/alma/apis/courses
  - https://developers.exlibrisgroup.com/rapido/apis/resources
  - https://developers.exlibrisgroup.com/rapido/apis/users
  - https://developers.exlibrisgroup.com/rapido/apis/lendingrequests
  - https://developers.exlibrisgroup.com/rapido/apis/partners
servers:
- url: https://gateway-hostname
tags:
- name: Almaws
paths:
  /almaws/v1/courses:
    get:
      operationId: get_almaws_v1_courses
      tags:
      - Almaws
      summary: Retrieve Courses
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_almaws_v1_courses
      tags:
      - Almaws
      summary: Add a new Course
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /almaws/v1/courses/{courseId}:
    delete:
      operationId: delete_almaws_v1_courses_courseId
      tags:
      - Almaws
      summary: Remove Course
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_almaws_v1_courses_courseId
      tags:
      - Almaws
      summary: Retrieve Course
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_almaws_v1_courses_courseId
      tags:
      - Almaws
      summary: Enroll to course
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_almaws_v1_courses_courseId
      tags:
      - Almaws
      summary: Update Course
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /almaws/v1/courses/{courseId}/lists/{listId}:
    delete:
      operationId: delete_almaws_v1_courses_courseId_lists_listId
      tags:
      - Almaws
      summary: Delete Course Enrollment
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: listId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /almaws/v1/courses/{courseId}/reading-lists:
    post:
      operationId: post_almaws_v1_courses_courseId_reading_lists
      tags:
      - Almaws
      summary: Create a Reading List
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /almaws/v1/courses/{courseId}/reading-lists/{readingListId}:
    delete:
      operationId: delete_almaws_v1_courses_courseId_reading_lists_readingListId
      tags:
      - Almaws
      summary: Remove Reading List
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_almaws_v1_courses_courseId_reading_lists_readingListId
      tags:
      - Almaws
      summary: Retrieve a Reading List
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_almaws_v1_courses_courseId_reading_lists_readingListId
      tags:
      - Almaws
      summary: Update a Reading List
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/citations/{citationId}:
    delete:
      operationId: delete_almaws_v1_courses_courseId_reading_lists_readingListId_citations_citation
      tags:
      - Almaws
      summary: Remove Citation
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: citationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_almaws_v1_courses_courseId_reading_lists_readingListId_citations_citationId
      tags:
      - Almaws
      summary: Retrieve Citation
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: citationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_almaws_v1_courses_courseId_reading_lists_readingListId_citations_citationId
      tags:
      - Almaws
      summary: Remove file from citation
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: citationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_almaws_v1_courses_courseId_reading_lists_readingListId_citations_citationId
      tags:
      - Almaws
      summary: Update Citation
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: citationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/citations/{citationId}/tags:
    get:
      operationId: get_almaws_v1_courses_courseId_reading_lists_readingListId_citations_citationId_
      tags:
      - Almaws
      summary: Retrieves Tags
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: citationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_almaws_v1_courses_courseId_reading_lists_readingListId_citations_citationId_
      tags:
      - Almaws
      summary: Update Tags
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: citationId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/owners/{primaryId}:
    delete:
      operationId: delete_almaws_v1_courses_courseId_reading_lists_readingListId_owners_primaryId
      tags:
      - Almaws
      summary: Delete Owner
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: primaryId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_almaws_v1_courses_courseId_reading_lists_readingListId_owners_primaryId
      tags:
      - Almaws
      summary: Retrieve Owner
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: primaryId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    put:
      operationId: put_almaws_v1_courses_courseId_reading_lists_readingListId_owners_primaryId
      tags:
      - Almaws
      summary: Update Owner
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: primaryId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /almaws/v1/courses/{courseId}/reading-lists/{readingListId}/{id}:
    get:
      operationId: get_almaws_v1_courses_courseId_reading_lists_readingListId_id
      tags:
      - Almaws
      summary: Retrieve Citations
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at id
    post:
      operationId: post_almaws_v1_courses_courseId_reading_lists_readingListId_id
      tags:
      - Almaws
      summary: Create Citation
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: readingListId
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at id
  /almaws/v1/courses/{courseId}/users/{userId}:
    delete:
      operationId: delete_almaws_v1_courses_courseId_users_userId
      tags:
      - Almaws
      summary: Delete Course Enrollment
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: userId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /almaws/v1/courses/{courseId}/{id}:
    get:
      operationId: get_almaws_v1_courses_courseId_id
      tags:
      - Almaws
      summary: Retrieve Reading Lists
      x-source: https://developers.exlibrisgroup.com/alma/apis/courses
      parameters:
      - name: courseId
        in: path
        required: true
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at id
  /almaws/version/resource-name/parameters:
    get:
      operationId: get_almaws_version_resource_name_parameters
      tags:
      - Almaws
      summary: GET /almaws/version/resource-name/parameters
      x-source: https://developers.exlibrisgroup.com/alma/apis
      parameters:
      - name: additional_parameter
        in: query
        required: false
        schema:
          type: string
      - name: apikey
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAlmawsVersionResourceNameParametersResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl. Note that only GET requests are permitted in the guest sandbox. About the Alma REST APIs To learn about the structure of Alma REST APIs, see the article “ How We’re Building APIs at Ex Libris “. Structure of the REST URIs The Alma RESTful API provides access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The s
components:
  schemas:
    GetAlmawsVersionResourceNameParametersResponse:
      type: object
      properties:
        errorsExist:
          type: boolean
        errorList:
          type: object
          properties:
            error:
              type: array
              items:
                type: object
                properties:
                  errorCode:
                    type: string
                  errorMessage:
                    type: string
                  trackingId:
                    type: string
        result:
          type:
          - string
          - 'null'