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

# Oboard

Oboard is an objectives and key results platform for managing goals, progress, teams, and workspaces.

- **Category:** productivity
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 32
- **Triggers:** 0
- **Slug:** `OBOARD`
- **Version:** 00000000_00

## Tools

### Add Users to Group

**Slug:** `OBOARD_ADD_USERS_TO_GROUP`

Add one or more existing Oboard users to a group. Use only when the connected deployment exposes group membership management; Web app connections reject this operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | Numeric ID of the group receiving the users. |
| `user_account_ids` | array | Yes | Account IDs of users to add; at least one nonempty ID is required. |

#### 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 Check-In

**Slug:** `OBOARD_CREATE_CHECKIN`

Create a check-in that records a progress value, status, or comment for an Oboard element. When checkin_date is supplied, Oboard stores its UTC calendar day and may replace the time with 23:59:59.000Z.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment` | string | No | Check-in comment; at least one of new_value, new_status, or comment is required. |
| `new_value` | number | No | New progress value; at least one of new_value, new_status, or comment is required. |
| `account_id` | string | Yes | Account ID of the check-in author. The current OpenAPI marks this optional, but the live provider rejects its omission. |
| `element_id` | integer | Yes | Element receiving the check-in. |
| `new_status` | integer | No | New status identifier; at least one of new_value, new_status, or comment is required. |
| `checkin_date` | string | No | Check-in calendar date in ISO 8601 format. Oboard may ignore the supplied time of day and store 23:59:59.000Z; omit to use the current date. |
| `update_nested_status` | boolean | No | Whether to update the status of nested elements; explicit null is sent as null. |

#### 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 Element

**Slug:** `OBOARD_CREATE_ELEMENT`

Create an Oboard objective, key result, or Jira-linked element in a workspace and interval. Oboard requires integer manual start-date and due-date states plus grade mode 1 (automatic) or 2 (manual).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Element name. |
| `unit` | string | No | Metric unit. |
| `users` | array | No | User assignments and their element role IDs. The API docs mark this field optional, but omission sends an empty array because the live runtime requires the key. |
| `groups` | array | No | Groups to assign, identified by numeric group ID. The API docs mark this field optional, but omission sends an empty array because the live runtime requires the key. |
| `private` | boolean | No | Whether the new element is private. The live provider applies the private key; the OpenAPI's isPrivate key is accepted but ignored. |
| `due_date` | string | No | Calculated or effective ISO 8601 calendar date or calendar timestamp. Oboard receives it normalized to UTC with millisecond precision. |
| `level_id` | integer | Yes | Strategic component for the element. |
| `label_ids` | array | No | Label IDs to assign. |
| `parent_id` | integer | No | Parent element ID; omit for a root element. |
| `contribute` | boolean | No | Whether this element contributes to its parent. |
| `grade_mode` | integer ("1" | "2") | Yes | Required grade mode: 1 for automatic or 2 for manual. |
| `start_date` | string | No | Effective ISO 8601 calendar date or calendar timestamp. Oboard receives it normalized to UTC with millisecond precision. |
| `description` | string | No | Element description. |
| `interval_id` | integer | Yes | Interval in which to create the element. |
| `target_value` | number | No | Target measured value. |
| `workspace_id` | integer | Yes | Workspace in which to create the element. |
| `current_value` | number | No | Initial measured value. |
| `custom_fields` | object | No | Custom-field values keyed by custom-field ID. |
| `field_type_id` | integer | No | Measurement field type ID. |
| `granulation_id` | integer | No | Metric granulation configuration ID. Oboard does not publish accepted IDs; use a value from an existing compatible element. |
| `jira_issue_ids` | array | No | Jira issue IDs to link. |
| `original_value` | number | No | Baseline value for progress calculations. |
| `due_date_manual` | integer | Yes | Required int32 manual due-date state. Oboard does not publish accepted values; 0 is live-verified. |
| `start_date_manual` | integer | Yes | Required int32 manual start-date state. Oboard does not publish accepted values; 0 is live-verified. |
| `confidence_level_id` | integer ("1" | "2" | "3" | "4" | "5" | "6" | "9") | No | Initial confidence state: 1 on track, 2 behind, 3 at risk, 4 not started, 5 closed, 6 abandoned, or 9 backlog. |
| `update_nested_status` | boolean | No | Apply relevant status changes to nested elements. |
| `period_aggregation_type_id` | integer | No | Period aggregation configuration ID. Oboard does not publish accepted IDs; use a value from an existing compatible element. |
| `threshold_condition_type_id` | integer | No | Threshold-condition configuration ID. The live provider requires this for numeric KPI elements using field_type_id 6. Copy the ID from a compatible element returned by GET_ELEMENT; Oboard does not publish accepted IDs. |
| `progress_aggregation_type_id` | integer | No | Progress aggregation configuration ID. Oboard does not publish accepted IDs; use a value from an existing compatible element. |

#### 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 Element Value

**Slug:** `OBOARD_CREATE_ELEMENT_VALUE`

Create a dated numeric value for an Oboard element. value_date is required in YYYY-MM-DD format and cannot be after the current UTC date. Oboard returns only a confirmation string, not the created value ID; use LIST_ELEMENT_VALUES to identify the resulting record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `new_value` | string | Yes | Numeric value to record. Required by this action so the creation has an agent-observable value; explicit null is sent as null. |
| `element_id` | integer | Yes | Element that will receive the dated value. |
| `value_date` | string | Yes | Date to record in YYYY-MM-DD format. Oboard rejects timestamps and dates after the current UTC date. |

#### 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 Group

**Slug:** `OBOARD_CREATE_GROUP`

Create an Oboard group in selected workspaces or all workspaces.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | integer | Yes | Group icon number from 1 through 32. |
| `name` | string | Yes | Group name. |
| `color` | string ("#B5BBC5" | "#CBCFD6" | "#DFE1E6" | "#85B2DD" | "#A7C4EC" | "#BFD4F2" | "#86D1B2" | "#AFE0CB" | "#CDECDF" | "#B69EF3" | "#CAC0F5" | "#D6D4F6" | "#F8768A" | "#FAA4B1" | "#FDD1D8" | "#FFA370" | "#FCC289" | "#FDE1B8") | Yes | Group color from Oboard's documented palette. |
| `parent_id` | integer | No | Parent group ID; omit to create a root group. |
| `workspace_ids` | array | No | Workspace IDs for the group; required unless add_to_all_workspaces is true. An empty list is accepted by Oboard. |
| `platform_group_ids` | array | No | External platform group IDs to link. |
| `synced_with_platform` | boolean | No | Whether to synchronize the group with the linked platform. |
| `add_to_all_workspaces` | boolean | No | Add the group to every existing workspace. |

#### 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 Strategic Component

**Slug:** `OBOARD_CREATE_STRATEGIC_COMPONENT`

Create an Oboard strategic component with its ordering, type, workspace placement, and element rules. Oboard documents no delete action for a created strategic component, so creation may be permanent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Component name, at most 20 characters. |
| `color` | string | Yes | Six-digit RGB hex color. A leading # is accepted and removed because Oboard level colors omit it. |
| `prefix` | string | Yes | Display prefix for the component. Oboard publishes no length limit. |
| `type_id` | integer | Yes | Provider component type ID. Oboard does not publish an allowed-value enum. |
| `order_value` | number | Yes | Component ordering value. |
| `workspace_ids` | array | No | Specific workspace IDs when not adding the component to all workspaces; may be null. |
| `field_type_ids` | array | No | Measurement field type IDs supported by the component; may be null. |
| `allow_without_parent` | boolean | No | Whether elements may use this component without a parent; may be null. |
| `add_to_all_workspaces` | boolean | Yes | Whether to add the component to all workspaces. |

#### 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 |

### Delete Element

**Slug:** `OBOARD_DELETE_ELEMENT`

Delete one Oboard element and optionally its nested objectives.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Numeric ID of the element to delete. |
| `remove_nested_objectives` | boolean | No | Also delete nested objectives. Defaults to false so nested objectives remain intact when Oboard supports preserving them. |

#### 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 |

### Delete Element Value

**Slug:** `OBOARD_DELETE_ELEMENT_VALUE`

Delete one dated value record from an Oboard element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value_id` | integer | Yes | Value record to delete. |
| `element_id` | integer | Yes | Element that owns the value record. |

#### 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 |

### Delete Group

**Slug:** `OBOARD_DELETE_GROUP`

Delete one Oboard group, optionally deleting its users too.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | Numeric ID of the group to delete. |
| `keep_users` | boolean | No | Keep the group's users when deleting the group. Defaults to true for safety; set false only when those users should also be deleted. |

#### 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 Element

**Slug:** `OBOARD_GET_ELEMENT`

Retrieve one current Oboard element by its numeric ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Numeric ID of the element to retrieve. |
| `workspace_ids` | array | No | Workspace IDs used to resolve the element when needed. |

#### 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 Child Elements

**Slug:** `OBOARD_LIST_CHILD_ELEMENTS`

List and filter current child elements below a parent, including manual-weight metadata, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum child elements in this page. |
| `order` | array | No | Sort criteria for top-level child elements, in priority order. |
| `search` | string | No | Text to match in child element names or display IDs. |
| `type_ids` | array | No | Element types to include: 1 objective, 4 key result, or 5 Jira issue. |
| `group_ids` | array | No | Group IDs to include. |
| `label_ids` | array | No | Label IDs to include. |
| `level_ids` | array | No | Strategic component IDs to include. |
| `owner_ids` | array | No | Owner account IDs to include. |
| `parent_id` | integer | Yes | Parent element ID whose children to list. |
| `child_order` | array | No | Sort criteria for nested child elements, in priority order. |
| `due_date_to` | string | No | Maximum due timestamp in ISO 8601 format. |
| `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |
| `search_type` | integer | Yes | View context: 1 Explorer, 2 Bottom up, 3 Check in, 4 Check-in objective, or 5 Check-in key result. |
| `watcher_ids` | array | No | Watcher account IDs to include. |
| `interval_ids` | array | No | Interval IDs to include. |
| `due_date_from` | string | No | Minimum due timestamp in ISO 8601 format. |
| `start_date_to` | string | No | Maximum element start timestamp in ISO 8601 format. |
| `workspace_ids` | array | No | Workspace IDs to include. |
| `stakeholder_ids` | array | No | Stakeholder account IDs to include. |
| `start_date_from` | string | No | Minimum element start timestamp in ISO 8601 format. |
| `confidence_level_ids` | array | No | Confidence states to include. |
| `last_progress_update_to` | string | No | Maximum last progress-update timestamp in ISO 8601 format. |
| `last_progress_update_from` | string | No | Minimum last progress-update timestamp in ISO 8601 format. |

#### 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 Confidence Levels

**Slug:** `OBOARD_LIST_CONFIDENCE_LEVELS`

List Oboard confidence-level IDs and names, optionally restricted to accessible workspaces.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_ids` | array | No | Workspace IDs whose confidence levels to list. |

#### 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 Custom Fields

**Slug:** `OBOARD_LIST_CUSTOM_FIELDS`

List Oboard custom-field definitions across accessible workspaces.

#### 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 Element Comments

**Slug:** `OBOARD_LIST_ELEMENT_COMMENTS`

Retrieve comments for one or more Oboard elements. Date bounds are inclusive and are enforced locally because Oboard does not consistently apply them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `html` | boolean | No | Whether Oboard should return comment content rendered as HTML. |
| `end_date` | string | No | Latest comment timestamp to include, in ISO 8601 format. |
| `start_date` | string | No | Earliest comment timestamp to include, in ISO 8601 format. |
| `element_ids` | array | Yes | One or more element IDs whose comments to retrieve. The live Oboard API rejects date-only requests even though its OpenAPI marks this field optional. |

#### 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 Element Progress History

**Slug:** `OBOARD_LIST_ELEMENT_PROGRESS_HISTORY`

Retrieve dated progress values for multiple Oboard elements, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum history records in this page. |
| `end_date` | string | No | Latest history date to include, in YYYY-MM-DD format. |
| `start_date` | string | No | Earliest history date to include, in YYYY-MM-DD format. |
| `element_ids` | array | Yes | Element IDs whose progress histories to retrieve. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |

#### 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 Elements

**Slug:** `OBOARD_LIST_ELEMENTS`

List and filter current Oboard objectives, key results, and Jira-linked elements, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum elements in this page. |
| `order` | array | No | Sort criteria for top-level elements, in priority order. |
| `search` | string | No | Text to match in elements. |
| `type_ids` | array | No | Element types: 1 objective, 4 key result, or 5 Jira issue. |
| `group_ids` | array | No | Group IDs to include. |
| `label_ids` | array | No | Label IDs to include. |
| `level_ids` | array | No | Strategic component IDs to include. |
| `owner_ids` | array | No | Owner account IDs to include. |
| `parent_ids` | array | No | Parent element IDs to include. |
| `child_order` | array | No | Sort criteria for nested child elements, in priority order. |
| `due_date_to` | string | No | Include elements due at or before this ISO 8601 timestamp. |
| `element_ids` | array | No | Specific element IDs to include. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `search_type` | integer ("1" | "2" | "3" | "4" | "5") | No | View context: 1 Explorer, 2 Bottom up, 3 Check in, 4 Check-in objective, or 5 Check-in key result. |
| `watcher_ids` | array | No | Watcher account IDs to include. |
| `interval_ids` | array | No | Interval IDs to include. |
| `due_date_from` | string | No | Include elements due at or after this ISO 8601 timestamp. |
| `items_to_open` | array | No | Element IDs whose children should be opened. |
| `start_date_to` | string | No | Include elements starting at or before this ISO 8601 timestamp. |
| `workspace_ids` | array | No | Workspace IDs to include. |
| `max_open_level` | integer | No | Maximum hierarchy depth to open. |
| `stakeholder_ids` | array | No | Stakeholder account IDs to include. |
| `start_date_from` | string | No | Include elements starting at or after this ISO 8601 timestamp. |
| `confidence_level_ids` | array | No | Confidence states: 1 on track, 2 behind, 3 at risk, 4 not started, 5 closed, 6 abandoned, or 9 backlog. |
| `last_progress_update_to` | string | No | Include elements whose progress was updated at or before this ISO 8601 timestamp. |
| `last_progress_update_from` | string | No | Include elements whose progress was updated at or after this ISO 8601 timestamp. |
| `include_foreign_objectives` | boolean | No | Include cross-workspace objectives. |

#### 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 Element Values

**Slug:** `OBOARD_LIST_ELEMENT_VALUES`

List all dated values recorded for one Oboard element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Element whose dated values to list. |

#### 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 Groups

**Slug:** `OBOARD_LIST_GROUPS`

List current Oboard groups and their workspace, permission, synchronization, and user-count metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_ids` | array | No | Workspace IDs to include. |

#### 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 Intervals

**Slug:** `OBOARD_LIST_INTERVALS`

List planning intervals, dates, and open or backlog state for one workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | integer | Yes | Workspace whose planning intervals to list. |

#### 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 Labels

**Slug:** `OBOARD_LIST_LABELS`

List current Oboard labels, optionally filtered by name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Label name text to filter by. |

#### 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 Strategic Components

**Slug:** `OBOARD_LIST_STRATEGIC_COMPONENTS`

List current Oboard strategic components, optionally filtered by component or workspace IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_ids` | array | No | Workspace IDs to include. |
| `strategic_component_ids` | array | No | Strategic component IDs to include. |

#### 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 Users

**Slug:** `OBOARD_LIST_USERS`

Search current Oboard users across workspaces, roles, and groups, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum users in this page. |
| `search` | string | No | Text to match against user names or email addresses. |
| `role_ids` | array | No | Workspace role IDs to include. |
| `group_ids` | array | No | Group IDs to include. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `workspace_id` | integer | No | Restrict users to one workspace ID. |

#### 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 Workspaces

**Slug:** `OBOARD_LIST_WORKSPACES`

List workspaces accessible to the connected Oboard API token.

#### 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 |

### Remove Users from Group

**Slug:** `OBOARD_REMOVE_USERS_FROM_GROUP`

Remove one or more existing Oboard users from a group. Use only when the connected deployment exposes group membership management; Web app connections reject this operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | Group from which to remove users. |
| `user_account_ids` | array | Yes | Account IDs of users to remove; at least one ID is required. |

#### 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 |

### Replace Element

**Slug:** `OBOARD_REPLACE_ELEMENT`

Update an existing Oboard element through its broad PUT operation, which can set editable metadata, hierarchy, progress, assignments, integer manual-date states, and privacy in one call. The request sends the element ID and only optional fields you provide; explicit null values are sent, while omitted fields are not sent, and Oboard does not document whether omission preserves or resets them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement element name. |
| `unit` | string | No | Replacement metric unit. |
| `grade` | number | No | Replacement grade value. |
| `users` | array | No | Replacement user assignments. |
| `groups` | array | No | Replacement group assignments. |
| `private` | boolean | No | Replacement privacy setting. |
| `due_date` | string | No | Replacement effective due timestamp in ISO 8601 format. |
| `level_id` | integer | No | Replacement strategic component ID. |
| `label_ids` | array | No | Replacement label IDs. |
| `parent_id` | integer | No | Replacement parent element ID. |
| `contribute` | boolean | No | Whether the element contributes to its parent. |
| `element_id` | integer | Yes | Element ID to replace. |
| `grade_mode` | integer ("1" | "2") | No | Replacement grade mode: 1 automatic or 2 manual. |
| `start_date` | string | No | Replacement effective start timestamp in ISO 8601 format. |
| `description` | string | No | Replacement description. |
| `interval_id` | integer | No | Replacement interval ID. |
| `order_value` | integer | No | Replacement position among sibling elements. |
| `target_value` | number | No | Replacement target value. |
| `workspace_id` | integer | No | Replacement workspace ID. |
| `current_value` | number | No | Replacement current value. |
| `custom_fields` | object | No | Replacement custom-field map keyed by custom-field ID. |
| `field_type_id` | integer | No | Replacement measurement field type. |
| `jira_issue_id` | string | No | Replacement linked Jira issue ID. |
| `granulation_id` | integer | No | Replacement metric granulation configuration ID. Oboard does not publish accepted IDs; use a value from the target element. |
| `original_value` | number | No | Replacement baseline value. |
| `due_date_manual` | integer | No | Optional nullable int32 manual due-date state. Oboard does not publish accepted values; 0 is live-verified. |
| `start_date_manual` | integer | No | Optional nullable int32 manual start-date state. Oboard does not publish accepted values; 0 is live-verified. |
| `confidence_level_id` | integer ("1" | "2" | "3" | "4" | "5" | "6" | "9") | No | Replacement confidence state: 1 on track, 2 behind, 3 at risk, 4 not started, 5 closed, 6 abandoned, or 9 backlog. |
| `update_nested_status` | boolean | No | Apply relevant status changes to nested elements. |
| `period_aggregation_type_id` | integer | No | Replacement period aggregation configuration ID. Oboard does not publish accepted IDs; use a value from the target element. |
| `threshold_condition_type_id` | integer | No | Replacement threshold-condition configuration ID. It is required by the live provider for numeric KPI elements using field_type_id 6; copy the current ID from GET_ELEMENT because Oboard does not publish accepted IDs. |
| `progress_aggregation_type_id` | integer | No | Replacement progress aggregation configuration ID. Oboard does not publish accepted IDs; use a value from the target element. |

#### 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 |

### Replace Group

**Slug:** `OBOARD_REPLACE_GROUP`

Replace the settings, workspace links, platform links, and membership list of an existing Oboard group. Use only when the connected deployment exposes group management; Web app connections reject this operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `icon` | integer | Yes | Replacement icon number from 1 through 32. |
| `name` | string | Yes | Replacement group name. |
| `color` | string ("#B5BBC5" | "#CBCFD6" | "#DFE1E6" | "#85B2DD" | "#A7C4EC" | "#BFD4F2" | "#86D1B2" | "#AFE0CB" | "#CDECDF" | "#B69EF3" | "#CAC0F5" | "#D6D4F6" | "#F8768A" | "#FAA4B1" | "#FDD1D8" | "#FFA370" | "#FCC289" | "#FDE1B8") | Yes | Replacement group color from Oboard's documented palette. |
| `synced` | boolean | Yes | Whether platform synchronization is enabled. |
| `group_id` | integer | Yes | ID of the group to replace. |
| `parent_id` | integer | No | Replacement parent group ID, or null for no parent. |
| `workspace_ids` | array | Yes | Complete replacement list of workspace IDs; use all accessible IDs when adding the group to all workspaces if required by Oboard. |
| `platform_group_ids` | array | Yes | Complete replacement list of linked platform group IDs; use an empty list for none. |
| `add_to_all_workspaces` | boolean | Yes | Whether the group belongs to all accessible workspaces. |
| `platform_user_account_ids` | array | Yes | Complete replacement list of platform user account IDs; use an empty list for none. |

#### 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 Check-Ins

**Slug:** `OBOARD_SEARCH_CHECKINS`

Search check-ins for selected elements and optionally include element or comment details, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | array | No | Check-in IDs to include; an empty list is preserved. |
| `limit` | integer | No | Maximum check-ins to return in this page. |
| `group_ids` | array | No | Group IDs whose check-ins to include; an empty list is preserved. |
| `created_to` | string | No | Latest check-in creation timestamp in ISO 8601 format. |
| `element_ids` | array | No | Element IDs whose check-ins to search; optional when using other filters. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call; omit for the first page. |
| `created_from` | string | No | Earliest check-in creation timestamp in ISO 8601 format. |
| `checkin_owner_ids` | array | No | Account IDs of check-in owners to include; an empty list is preserved. |
| `include_element_data` | boolean | Yes | Include related element data in each check-in. |
| `include_comments_data` | boolean | Yes | Include detailed comment data in each check-in. |
| `include_checkin_from_group_users` | boolean | Yes | Include check-ins created by users in the element's groups. |

#### 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 Check-In

**Slug:** `OBOARD_UPDATE_CHECKIN`

Update an existing Oboard check-in's progress value, status, or comment. At least one change is required. When checkin_date is supplied, Oboard stores its UTC calendar day and may replace the time with 23:59:59.000Z. When it is omitted or null, Oboard chooses the resulting date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment` | string | No | Replacement check-in comment; provide this, new_value, or new_status. |
| `new_value` | number | No | Replacement progress value; provide this, new_status, or comment. |
| `account_id` | string | Yes | Account ID of the user making the update. |
| `checkin_id` | integer | Yes | Numeric ID of the check-in to update. |
| `new_status` | integer | No | Replacement status ID; provide this, new_value, or comment. |
| `checkin_date` | string | No | Replacement check-in calendar date in ISO 8601 format. Oboard may ignore the supplied time of day and store 23:59:59.000Z; when omitted or null, Oboard chooses the resulting date. |
| `update_nested_status` | boolean | No | Apply relevant status changes to nested elements. |

#### 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 Element Properties

**Slug:** `OBOARD_UPDATE_ELEMENT_PROPERTIES`

Update one or more named properties on an existing Oboard element without replacing the complete element.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `element_id` | integer | Yes | Numeric ID of the element to update. |
| `properties` | array | Yes | Property updates to apply; at least one is required. The officially documented example is property_name name with a string new_value. |

#### 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 Element Value

**Slug:** `OBOARD_UPDATE_ELEMENT_VALUE`

Update the numeric value of one Oboard element-value record. Oboard documents new_value as optional and nullable; this action requires it so the call can perform an agent-observable update. The provider returns only a confirmation string; value_id remains the record identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `value_id` | integer | Yes | Value record to update. |
| `new_value` | string | Yes | Replacement numeric value. Required by this action so the update has an agent-observable value; explicit null is sent as null. |
| `element_id` | integer | Yes | Element that owns the value record. |

#### 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 Strategic Component

**Slug:** `OBOARD_UPDATE_STRATEGIC_COMPONENT`

Update an existing Oboard strategic component's identity, ordering, and element rules. This changes a shared hierarchy component that can affect elements across its workspaces.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Replacement component name, at most 20 characters. Required and nullable. |
| `color` | string | Yes | Replacement six-digit RGB hex color. Required and nullable; a leading # is removed before sending. |
| `prefix` | string | Yes | Replacement display prefix. Required and nullable; Oboard publishes no length limit. |
| `level_id` | integer | Yes | Strategic component ID to update. The provider OpenAPI permits null, but this action requires an ID so the shared hierarchy target and response can be verified. |
| `order_value` | string | Yes | Replacement ordering value. Required and nullable. |
| `field_type_ids` | array | No | Replacement measurement field type IDs; may be null. |
| `allow_without_parent` | boolean | No | Whether elements may use this component without a parent; may be null. |

#### 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 User Roles

**Slug:** `OBOARD_UPDATE_USER_ROLES`

Bulk update users' workspace roles. This changes user authorization; use only with the intended account, workspace, and role IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role_updates` | array | Yes | Authorization changes to apply; at least one complete account, workspace, and intended role assignment is required. The provider OpenAPI permits empty or partial entries, but those cannot identify an authorization change and are rejected by this action. |

#### 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 |