---
canonical_url: "https://docs.composio.dev/toolkits/itm_platform"
markdown_url: "https://docs.composio.dev/toolkits/itm_platform.md"
product: "platform"
version: null
last_updated: null
---

# ITM Platform

ITM Platform provides modern project, portfolio, task, service, financial, risk, and resource management APIs plus read-only DataMart analytics.

- **Category:** project management
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `ITM_PLATFORM`
- **Version:** 00000000_00

## Tools

### Aggregate DataMart Components

**Slug:** `ITM_PLATFORM_AGGREGATE_DATAMART_COMPONENTS`

Run a bounded read-only DataMart aggregation over project and service records for portfolio analytics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pipeline` | array | Yes | MongoDB-style read-only aggregation stages. Each stage must contain exactly one supported operator, and the final stage must be a positive $limit no greater than 1000. $lookup is forbidden. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Project

**Slug:** `ITM_PLATFORM_CREATE_PROJECT`

Create an ITM Platform project with its schedule and optional account-specific classification IDs. This changes customer data and has no v2 delete counterpart.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Project name. |
| `type_id` | integer | No | Account-specific project type ID; retrieve reference data rather than guessing. |
| `end_date` | string | No | Project end date as an ISO 8601 date or date-time; must not precede start_date. |
| `status_id` | integer | No | Account-specific project status ID from List Reference Data. |
| `start_date` | string | No | Project start date as an ISO 8601 date or date-time. |
| `description` | string | No | Project description; ITM Platform may store HTML. |
| `priority_id` | integer | No | Account-specific project priority ID from List Reference Data. |
| `internal_code` | string | No | Internal project code. |
| `is_kanban_project` | boolean | No | Whether to create the project with Kanban behavior enabled. |
| `performing_unit_id` | integer | No | Account-specific organizational unit responsible for the project. |
| `internal_cost_center` | string | No | Internal cost-center code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Task

**Slug:** `ITM_PLATFORM_CREATE_TASK`

Create a task in an ITM Platform project using account-defined type, priority, and status names.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Task name. |
| `details` | string | No | Task details or acceptance notes. |
| `end_date` | string | No | Task end date in YYYY-MM-DD format; must not precede start_date. |
| `sprint_id` | string | No | Sprint ID to assign, if the project uses sprints. |
| `type_name` | string | No | Exact account-defined task type name from List Reference Data. |
| `project_id` | integer | Yes | Project ID that will own the task. |
| `start_date` | string | No | Task start date in YYYY-MM-DD format. |
| `status_name` | string | No | Exact account-defined task status name from List Reference Data. |
| `priority_name` | string | No | Exact account-defined task priority name from List Reference Data. |
| `swimlane_name` | string | No | Exact Kanban swimlane name for the new task. |
| `parent_task_id` | string | No | Parent task ID when creating a child task. |
| `display_in_portfolio` | boolean | No | Whether the task should appear in portfolio views. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Project

**Slug:** `ITM_PLATFORM_GET_PROJECT`

Return the full current details of one project by its ITM Platform project ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | integer | Yes | ITM Platform project ID returned by Search Projects or Create Project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Reference Data

**Slug:** `ITM_PLATFORM_LIST_REFERENCE_DATA`

List account-defined project or task statuses, priorities, or types needed to form valid project and task mutations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `kind` | string ("project_statuses" | "project_priorities" | "project_types" | "task_statuses" | "task_priorities" | "task_types") | Yes | Reference collection to list: project_statuses, project_priorities, project_types, task_statuses, task_priorities, or task_types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search DataMart Components

**Slug:** `ITM_PLATFORM_SEARCH_DATAMART_COMPONENTS`

Search the read-only DataMart for project or service analytics records and return one offset-paginated page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | object | No | MongoDB-style sort map from field names to 1 for ascending or -1 for descending order. |
| `limit` | integer | No | Maximum DataMart components in this page (1-200). |
| `where` | object | No | MongoDB-style DataMart filter over component fields, for example componentType or nested task fields. |
| `project` | object | No | MongoDB-style projection selecting only needed fields. Use dot notation for nested arrays, such as tasks.name, instead of selecting whole arrays. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response. When set, reuse it without changing the query criteria. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Projects

**Slug:** `ITM_PLATFORM_SEARCH_PROJECTS`

Search projects by account-specific filters and return one page of project summaries with a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Project fields to return, for example Id, Name, StartDate, EndDate, Status, or Priority. |
| `filter` | object | No | MongoDB-style project filter using provider field names and operators such as $regex, $in, $gte, or $lte. |
| `page_size` | integer | No | Maximum projects to return in this page (1-500). |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response. When set, reuse it without changing the search criteria. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Tasks

**Slug:** `ITM_PLATFORM_SEARCH_TASKS`

Search tasks across accessible projects and return one page of task summaries with a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | array | No | Task fields to return, for example Id, ProjectId, Name, StartDate, EndDate, Status, or Priority. |
| `filter` | object | No | MongoDB-style task filter using provider field names, for example ProjectId equality or Name with $regex. |
| `page_size` | integer | No | Maximum tasks to return in this page (1-500). |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response. When set, reuse it without changing the search criteria. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Project

**Slug:** `ITM_PLATFORM_UPDATE_PROJECT`

Update selected fields of an existing ITM Platform project and return the provider result. Verify important changes with Get Project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New project name. |
| `type_id` | integer | No | New account-specific project type ID. |
| `end_date` | string | No | New end date as an ISO 8601 date or date-time. When start_date is also provided, end_date must not precede it. |
| `status_id` | integer | No | New project status ID from List Reference Data. |
| `project_id` | integer | Yes | ITM Platform project ID to update. |
| `start_date` | string | No | New start date as an ISO 8601 date or date-time. |
| `description` | string | No | New project description; ITM Platform may store HTML. |
| `priority_id` | integer | No | New project priority ID from List Reference Data. |
| `internal_code` | string | No | New internal project code. |
| `performing_unit_id` | integer | No | New account-specific performing unit ID. |
| `internal_cost_center` | string | No | New internal cost-center code. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Task

**Slug:** `ITM_PLATFORM_UPDATE_TASK`

Update selected descriptive, scheduling, hierarchy, or custom fields on an existing ITM Platform project task. Verify important changes with Search Tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New task name. |
| `details` | string | No | New task details. |
| `task_id` | integer | Yes | ID of the task to update. |
| `end_date` | string | No | New end date in YYYY-MM-DD format. When start_date is also provided, end_date must not precede it. |
| `sprint_id` | string | No | New sprint ID, if applicable. |
| `project_id` | integer | Yes | ID of the project that owns the task. |
| `start_date` | string | No | New start date in YYYY-MM-DD format. |
| `custom_fields` | array | No | Custom-field updates. Each item requires custom_field_base_id, value, and type_name from the account's custom-field definitions. |
| `swimlane_name` | string | No | Exact Kanban swimlane name. |
| `parent_task_id` | string | No | New parent task ID. |
| `display_in_portfolio` | boolean | No | Whether the task appears in portfolio views. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |