# Workiom

Workiom allows businesses to create custom workflows, integrate apps, and automate processes, reducing manual overhead and streamlining operations

- **Category:** productivity
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 3
- **Triggers:** 0
- **Slug:** `WORKIOM`
- **Version:** 20260223_00

## Tools

### Create record

**Slug:** `WORKIOM_CREATE_RECORD`

Creates a new record in a specified Workiom list. This tool creates a record with basic field types like text, numbers, dates, and static list items. The record data should be provided as a JSON object where each key is a field ID and the value matches the expected data type for that field.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | The ID of the list where the record will be created |
| `record_data` | object | Yes | A JSON object containing the field values for the new record. Each key should be a field ID, and the value should match the expected data type. Supported field types: strings for text, numbers for numeric fields, ISO 8601 date strings for dates, objects with {id, label} for static list items, and arrays of objects for linked records. |

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

**Slug:** `WORKIOM_GET_ALL_LISTS`

Get all lists from a Workiom app. This action fetches all lists within a specific Workiom app. Lists are containers for records (similar to database tables) and are the fundamental data structure in Workiom. Each list has a unique ID and contains views for displaying data. Use this action to discover available lists before performing operations like creating records (which require a list ID).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `app_id` | string | Yes | The ID of the Workiom app to fetch lists from. This is a UUID that can be obtained from the Apps/GetAll endpoint or from the URL when viewing the app in Workiom. |

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

**Slug:** `WORKIOM_GET_RECORDS`

Retrieves records from a specified Workiom list. Use this action to fetch data from a Workiom list. The list_id is required and can be obtained from the WORKIOM_GET_ALL_LISTS action. Each record contains field values keyed by numeric field IDs. Features: - Pagination: Use max_result_count and skip_count to paginate through large datasets - Sorting: Sort by any field using 'FIELD_ID ASC' or 'FIELD_ID DESC' format - Filtering: Apply conditions using filter operators (Contains, Is, Greater, etc.) Note: Field IDs are numeric (e.g., 5037173) and can be found in list metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filters` | array | No | Optional array of filter conditions to apply. Multiple filters are combined with AND logic. |
| `list_id` | string | Yes | The UUID of the list to fetch records from. Obtain this from WORKIOM_GET_ALL_LISTS action. |
| `sorting` | string | No | Sort order in format 'FIELD_ID DIRECTION' where DIRECTION is ASC or DESC. Example: '5037173 ASC' sorts by field 5037173 ascending. |
| `skip_count` | integer | No | Number of records to skip from the beginning. Use with max_result_count for pagination (e.g., skip_count=10 with max_result_count=10 returns records 11-20). |
| `max_result_count` | integer | No | Maximum number of records to return per request. Use with skip_count for pagination. Default is all records. |

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