get all projects

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 projects	Boolean
sort	Sort order for results	String
with_contracts	Include contract information	Boolean
draft_versions_with_contract_only	Filter to draft versions with contracts	Boolean
labels	Filter by labels	String

Response Body

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

Project Structure

| Field name     | Description                                                      | Format  |
| :------------- | :--------------------------------------------------------------- | :------ |
| id             | Project ID                                                       | UUID    |
| name           | The name of the project                                          | String  |
| createdAt      | The date and time of creation                                    | String  |
| modifiedAt     | The date and time of modification                                | String  |
| modifiedBy     | Modified by                                                      | String  |
| sysModifiedAt  | The system date and time of modification                         | String  |
| description    | Project description                                              | String  |
| bookmarked     | Whether the project is bookmarked                                | Boolean |
| additionalInfo | [Additional info](#additional-info-structure)                    | Object  |
| version        | Current version number                                           | Integer |
| versions \[n]  | [Version entry](#version-entry-structure) for version number `n` | Object  |
| technology     | The technology type of the project                               | String  |

Additional Info Structure

| Field name   | Description                                   | Format  |
| :----------- | :-------------------------------------------- | :------ |
| numOfModules | Number of modules associated with the project | Integer |
| numOfAssets  | Number of assets associated with the project  | Integer |
| numOfMethods | Number of methods associated with the project | Integer |

Version Entry Structure

| Field name  | Description                           | Format  |
| :---------- | :------------------------------------ | :------ |
| version     | The version number                    | Integer |
| reason      | The reason for the version            | String  |
| versionedBy | The user who created the version      | String  |
| versionedAt | The date and time of version creation | String  |

Examples

projects

    {
      "elements": [
        {
          "id": "00000000-0000-0000-0000-000000000111",
          "name": "project-with-modules",
          "createdAt": "2026-01-01T00:00:00.000000Z",
          "modifiedAt": "2026-01-01T00:00:00.000000Z",
          "modifiedBy": "John Doe",
          "sysModifiedAt": "2026-01-01T00:00:00.000000Z",
          "description": "project with modules description",
          "bookmarked": false,
          "additionalInfo": {
            "numOfModules": 1,
            "numOfAssets": 1,
            "numOfMethods": 1
          },
          "version": 0,
          "versions": {
            "0": {
              "version": 0,
              "reason": "Draft",
              "versionedBy": "John Doe",
              "versionedAt": "2026-01-01T00:00:00.000000Z"
            }
          },
          "technology": "HTTP"
        }
      ],
      "total": 1
    }
    ```