How to query settings in Alma via the API Console

You need to register for an account with the Ex Libris Developer Network first.

Once that is set up:

Go to https://developers.exlibrisgroup.com/console/
Click on Alma, and then Configuration and Administration

The API for GET /almaws/v1/conf/code-tables will retrieve all of the available code tables.

Click Try it Out, and then click Execute, to get the code table list.

You'll receive a response in JSON format that gives you all of the available code tables: response_1692644766982.json

From that file, you'd look up the name of the code table that you wanted to retrieve. E.g., suppose you wanted to get the list for the table MandatoryLendingWorkflowSteps

Scroll back up the page to the General section, to the API for GET /almaws/v1/conf/code-tables/{codeTableName}

You'd click "Try it out", and then in the codeTableName box, put in MandatoryLendingWorkflowSteps

Then click Execute, and you get the response:

{
  "name": "MandatoryLendingWorkflowSteps",
  "description": "Lending Workflow Steps",
  "sub_system": {
    "value": "FULFILLMENT",
    "desc": "Fulfillment"
  },
  "patron_facing": true,
  "language": {
    "value": "en",
    "desc": "English"
  },
  "scope": {
    "institution_id": {
      "value": "API_GUEST_INST",
      "desc": "API Guest Institution"
    },
    "library_id": {
      "value": "",
      "desc": ""
    }
  },
  "row": [
    {
      "code": "BEING_PROCESSED",
      "description": "Being Processed",
      "default": false,
      "enabled": true
    },
    {
      "code": "CANCELLED",
      "description": "Cancelled",
      "default": false,
      "enabled": true
    },
    {
      "code": "DAMAGED",
      "description": "Damaged",
      "default": false,
      "enabled": true
    },
    {
      "code": "DELETED",
      "description": "Deleted",
      "default": false,
      "enabled": true
    },
    {
      "code": "EXPIRED",
      "description": "Expired",
      "default": false,
      "enabled": true
    },
    {
      "code": "LOCATE_FAILED",
      "description": "Locate failed",
      "default": false,
      "enabled": true
    },
    {
      "code": "LOST",
      "description": "Lost",
      "default": false,
      "enabled": true
    },
    {
      "code": "LOST_AND_FEE_COMMUNICATED",
      "description": "Lost and fee communicated",
      "default": false,
      "enabled": true
    },
    {
      "code": "NON_EXPIRING",
      "description": "Non expiring",
      "default": false,
      "enabled": true
    },
    {
      "code": "OVERDUE_ITEM",
      "description": "Overdue request",
      "default": false,
      "enabled": true
    },
    {
      "code": "PENDING_AUTO_REJECT",
      "description": "Pending Auto Reject",
      "default": false,
      "enabled": true
    },
    {
      "code": "RECALLED_LEND",
      "description": "Recalled item",
      "default": false,
      "enabled": true
    },
    {
      "code": "RECEIVED_BY_PARTNER",
      "description": "Received by partner",
      "default": false,
      "enabled": true
    },
    {
      "code": "REJECTED",
      "description": "Rejected the borrower request",
      "default": false,
      "enabled": true
    },
    {
      "code": "RENEW_REQUESTED",
      "description": "Renew requested",
      "default": false,
      "enabled": true
    },
    {
      "code": "REQUEST_COMPLETED",
      "description": "Request Completed",
      "default": false,
      "enabled": true
    },
    {
      "code": "REQUEST_CREATED_LEND",
      "description": "Created lending request",
      "default": false,
      "enabled": true
    },
    {
      "code": "RETURNED_BY_PARTNER",
      "description": "Returned by partner",
      "default": false,
      "enabled": true
    },
    {
      "code": "SHIPPED_DIGITALLY",
      "description": "Shipped Digitally",
      "default": false,
      "enabled": true
    },
    {
      "code": "SHIPPED_PHYSICALLY",
      "description": "Shipped Physically",
      "default": false,
      "enabled": true
    },
    {
      "code": "WILL_SUPPLY",
      "description": "Will Supply",
      "default": false,
      "enabled": true
    }
  ]
}