get project

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

Prerequisites

The caller must provide a project id.

Authorization

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

Parameters

Path Parameters

Field name	Description	Format
id	The ID of the project	UUID

Response Body

Field name	Description	Format
id	The ID of the project	UUID
name	The name of the project	String
createdAt	Timestamp when the project was created	String
modifiedAt	Timestamp when the project was last modified	String
modifiedBy	The user who last modified the project	String
sysModifiedAt	System timestamp when the project was last modified	String
description	The description of the project	String
bookmarked	Whether the project is bookmarked	Boolean
additionalInfo	Additional info	Object
version	The current version number of the project	Integer
versions [n]	Version entry for version number `n`	Object
technology	The technology type of the project	String

Additional Info Structure

Field name	Description	Format
numOfModules	Number of modules in the project	Integer
numOfAssets	Number of assets in the project	Integer
numOfMethods	Number of methods in the project	Integer
contractName	The contract name associated with the project	String
contractId	The ID of the associated contract	String

Version Entry Structure

Field name	Description	Format
version	The version number	Integer
reason	The reason for this version	String
versionedBy	The user who created this version	String
versionedAt	Timestamp when this version was created	String

Examples

{
  "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": "",
  "bookmarked": false,
  "additionalInfo": {
    "numOfModules": 1,
    "numOfAssets": 1,
    "numOfMethods": 1,
    "contractName": "project-with-modules-contract",
    "contractId": "00000000-0000-0000-0000-000000000000"
  },
  "version": 0,
  "versions": {
    "0": {
      "version": 0,
      "reason": "Draft",
      "versionedBy": "John Doe",
      "versionedAt": "2026-01-01T00:00:00.000000Z"
    }
  },
  "technology": "HTTP"
}

Parameters

Examples

200