---
updatedAt: 2025-06-03T20:39:53.000Z
agentTools:
  projectIndex: https://docs.ol-hub.com/llms.txt
---

# get project

The **get project** API sends a GET request to return various information for a specific project.

**Prerequisites**: The caller must supply the **id** for the requested project. This can be obtained by invoking the **get all projects** API.

**Authorization**: API key

**Input parameters**:

**Path Variables**:

| Name   | Description | Format |
| :----- | :---------- | :----- |
| **id** | Project id  | UUID   |

**Output parameters**:

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th>
        Field name
      </th>

      <th>
        Description
      </th>

      <th>
        Format
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        **name**
      </td>

      <td>
        Project name
      </td>

      <td>
        String
      </td>
    </tr>

    <tr>
      <td>
        **createdAt**
      </td>

      <td>
        Project creation datetime
      </td>

      <td>
        Instant
      </td>
    </tr>

    <tr>
      <td>
        **modifiedAt**
      </td>

      <td>
        Project modification datetime
      </td>

      <td>
        Instant
      </td>
    </tr>

    <tr>
      <td>
        **modifiedBy**
      </td>

      <td>
        User who modified project
      </td>

      <td>
        String
      </td>
    </tr>

    <tr>
      <td>
        **description**
      </td>

      <td>
        Project description
      </td>

      <td>
        String
      </td>
    </tr>

    <tr>
      <td>
        **bookmarked**
      </td>

      <td>
        Is project bookmarked?
      </td>

      <td>
        Boolean
      </td>
    </tr>

    <tr>
      <td>
        **additionalInfo**
      </td>

      <td>
        Container - see below
      </td>

      <td>
        additionalInfo
      </td>
    </tr>

    <tr>
      <td>
        **version**
      </td>

      <td>
        Project version number (default = null)
      </td>

      <td>
        Integer
      </td>
    </tr>

    <tr>
      <td>
        **versions**
      </td>

      <td>
        Number of project versions
      </td>

      <td>
        Integer
      </td>
    </tr>

    <tr>
      <td>
        **deploymentImage**
      </td>

      <td>
        If project is deployed, the no-code docker image of the project; otherwise null
      </td>

      <td>
        String
      </td>
    </tr>

    <tr>
      <td>
        **technology**
      </td>

      <td>
        Set of options currently supported in OL Hub project:\
        HTTP, IBM\_MQ, KAFKA, DB\_POLLER, CORBA, SFTP, ACTIVE\_MQ, SOAP, REVERSE
      </td>

      <td>
        ApiEnrichmentType
      </td>
    </tr>
  </tbody>
</Table>

**additionalInfo**:

| **Field name**   | **Description**              | **Format** |
| :--------------- | :--------------------------- | :--------- |
| **numofModules** | Number of modules in project | Integer    |
| **numofAssets**  | Number of assets in project  | Integer    |
| **numofMethods** | Number of methods in project | Integer    |
| **contractName** | Contract name                | String     |
| **contractID**   | Contract identifier          | UUID       |

**Example**:

```
{
    "project": {
        "id": "b8d28b7e-edfb-4c18-8fb7-e5b3d09db83f",
        "name": "item-1",
        "createdAt": "2021-07-18T14:23:52.060612Z",
        "modifiedAt": "2021-07-18T14:23:52.060608Z",
        "modifiedBy": "local dev",
        "description": "very crazy",
        "bookmarked": false,
        "additionalInfo": {
            "numOfModules": 1,
            "numOfAssets": 1,
            "numOfMethods": 1
        }
    }
}
```

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Public APIs - Projects",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.ol-hub.com/backend"
    }
  ],
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "tags": [
    {
      "name": "Project"
    }
  ],
  "paths": {
    "/api/v1/projects/{id}": {
      "get": {
        "tags": [
          "Project"
        ],
        "summary": "get project",
        "parameters": [
          {
            "name": "Content-Type",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "example": "application/json"
          },
          {
            "name": "id",
            "in": "path",
            "schema": {
              "type": "string"
            },
            "required": true,
            "example": "b8d28b7e-edfb-4c18-8fb7-e5b3d09db83f"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "transfer-encoding": {
                "schema": {
                  "type": "string",
                  "example": "chunked"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {
                  "project": {
                    "id": "b8d28b7e-edfb-4c18-8fb7-e5b3d09db83f",
                    "name": "item-1",
                    "createdAt": "2021-07-18T14:23:52.060612Z",
                    "modifiedAt": "2021-07-18T14:23:52.060608Z",
                    "modifiedBy": "local dev",
                    "description": "very crazy",
                    "bookmarked": false,
                    "additionalInfo": {
                      "numOfModules": 1,
                      "numOfAssets": 1,
                      "numOfMethods": 1
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```