read all modules

Prerequisites

• The caller does not have to provide anything.

Authorization

• API key (via the X-API-KEY header).

Parameters

Query Parameters

Field name	Description	Format
offset	Number of items to skip for pagination	Integer
limit	Maximum number of items to return	Integer
bookmarked	Filter by bookmarked modules	Boolean
projectId	Filter modules by project ID	String
module_type	Filter by module type	String
exclude_module_type	Exclude modules of a specific type	String
sort	Sort order for results	String

Response Body

Field name	Description	Format
elements	List of modules	Array
total	Total amount of modules	Integer

Module Structure

| Field name     | Description                                       | Format  |
| :------------- | :------------------------------------------------ | :------ |
| id             | Module ID                                         | UUID    |
| name           | The name of the module                            | String  |
| modifiedAt     | The date and time of modification                 | String  |
| modifiedBy     | Modified by                                       | String  |
| description    | Module description                                | String  |
| bookmarked     | Whether the module is bookmarked                  | Boolean |
| createdAt      | The date and time of creation                     | String  |
| createdBy      | Created by                                        | String  |
| connection     | [Module connection](#connection-structure)           | Object  |
| additionalInfo | [Additional module info](#additional-info-structure) | Object  |

Connection Structure

| Field name  | Description                               | Format |
| :---------- | :---------------------------------------- | :----- |
| id          | Connection ID                             | UUID   |
| name        | The name of the connection                | String |
| connector   | The type of connector                     | String |
| description | Connection description                    | String |
| profiles    | [Connection profiles](#profile-structure) | Map    |
| modifiedAt  | The date and time of modification         | String |
| modifiedBy  | Modified by                               | String |
| createdAt   | The date and time of creation             | String |
| createdBy   | Created by                                | String |

Additional Info Structure

| Field name       | Description                                   | Format  |
| :--------------- | :-------------------------------------------- | :------ |
| numOfAssets      | Number of assets associated with the module   | Integer |
| numOfProjects    | Number of projects associated with the module | Integer |
| type             | The module connector type                     | String  |
| modernizedModule | ID of the associated modernized module        | UUID    |

Profile Structure

| Field name   | Description    | Format      |
| :----------- | :------------- | :---------- |
| profileName  | Key            | String      |
| profileValue | Profile config | JsonElement |

Examples

modules

    {
      "elements": [
        {
          "id": "00000000-0000-0000-0000-000000000011",
          "name": "module-mainframe-rpc",
          "modifiedAt": "2026-01-01T00:00:00.000000Z",
          "modifiedBy": "John Doe",
          "description": "",
          "bookmarked": false,
          "createdAt": "2026-01-01T00:00:00.000000Z",
          "createdBy": "John Doe",
          "connection": {
            "id": "00000000-0000-0000-0000-000000000001",
            "name": "module-mainframe-rpc-default-connection-1",
            "connector": "mainFrameRpc",
            "description": "Auto-generated connection for module module-mainframe-rpc",
            "profiles": {
              "$default": {
                "baseUrl": "http://cics.example.internal",
                "uriMap": "/example/latest",
                "port": "12345",
                "codePage": "cp037"
              }
            },
            "modifiedAt": "2026-01-01T00:00:00.000000000Z",
            "modifiedBy": "",
            "createdAt": "2026-01-01T00:00:00.000000000Z",
            "createdBy": ""
          },
          "additionalInfo": {
            "numOfAssets": 0,
            "numOfProjects": 0,
            "type": "mainFrameRpc",
            "modernizedModule": "9b9e51de-940b-4ab5-836d-b3edf0c93353"
          }
        }
      ],
      "total": 1
    }
    ```