# Engage Bay — Sushidata (`sushidata/sushidata-engage-bay`) Actor

- **URL**: https://apify.com/sushidata/sushidata-engage-bay.md
- **Developed by:** [Sushidata](https://apify.com/sushidata) (community)
- **Categories:** Automation, Other, Developer tools
- **Stats:** 3 total users, 3 monthly users, 76.1% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md).

If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).


# README

## EngageBay CRM API Actor

Interact with the full [EngageBay](https://www.engagebay.com/) REST API from the Apify platform. This Actor supports **75 operations** across all EngageBay resources: Contacts, Companies, Deals, Tracks, Events, Tasks, Notes, Forms, Sequences, Lists, Owners, Custom Fields, Tickets, Tags, Products, and Broadcasts.

### Authentication

Find your REST API Key in **EngageBay → Account Admin Settings → API → REST API Key** and pass it as `apiKey`.

The `apiKey` input is marked as secret and will not appear in logs.

### Input

| Field             | Type    | Required | Description                                                      |
| ----------------- | ------- | -------- | ---------------------------------------------------------------- |
| `apiKey`          | string  | ✅       | EngageBay REST API Key                                           |
| `action`          | string  | ✅       | Operation to perform (see full list below)                       |
| `contactId`       | string  |          | Contact ID (for contact-specific operations)                     |
| `companyId`       | string  |          | Company ID                                                       |
| `dealId`          | string  |          | Deal ID                                                          |
| `trackId`         | string  |          | Track ID                                                         |
| `taskId`          | string  |          | Task ID                                                          |
| `ticketId`        | string  |          | Ticket ID                                                        |
| `productId`       | string  |          | Product ID                                                       |
| `formId`          | string  |          | Form ID                                                          |
| `sequenceId`      | string  |          | Sequence ID                                                      |
| `listId`          | string  |          | Contact List ID                                                  |
| `customFieldType` | string  |          | `CONTACT` / `DEAL` / `COMPANY` / `TICKET`                        |
| `customFieldId`   | string  |          | Custom Field ID (for delete)                                     |
| `email`           | string  |          | Contact email address (for email-based operations)               |
| `ownerEmail`      | string  |          | New owner email (for `contacts_change_owner`)                    |
| `searchQuery`     | string  |          | Keyword for search operations                                    |
| `startTime`       | integer |          | Epoch ms — required for `events_list`                            |
| `endTime`         | integer |          | Epoch ms — required for `events_list`                            |
| `pageSize`        | integer |          | Records per page (1–100, default 20)                             |
| `sortKey`         | string  |          | `created_time`, `updated_time`, or prepend `-` for descending    |
| `cursor`          | string  |          | Pagination cursor to resume from                                 |
| `fetchAll`        | boolean |          | Auto-paginate all pages (default `false`)                        |
| `data`            | object  |          | Request body / action-specific filters (see per-action examples) |

### Supported Actions

#### Contacts

| Action                       | Required fields           | `data` shape                                                               |
| ---------------------------- | ------------------------- | -------------------------------------------------------------------------- |
| `contacts_list`              | —                         | —                                                                          |
| `contacts_get`               | `contactId`               | —                                                                          |
| `contacts_get_by_email`      | `email`                   | —                                                                          |
| `contacts_create`            | —                         | [Contact JSON](https://github.com/engagebay/restapi#13-creating-a-contact) |
| `contacts_update`            | —                         | `{id, properties:[...]}`                                                   |
| `contacts_delete`            | `contactId`               | —                                                                          |
| `contacts_search`            | `searchQuery`             | —                                                                          |
| `contacts_add_tags`          | `email`                   | `{tags: ["tag1","tag2"]}`                                                  |
| `contacts_delete_tags`       | `email`                   | `{tags: ["tag1"]}`                                                         |
| `contacts_list_tags`         | `email`                   | —                                                                          |
| `contacts_list_tags_by_id`   | `contactId`               | —                                                                          |
| `contacts_add_tags_by_id`    | `contactId`               | `{tags: [{tag:"tag1"}]}`                                                   |
| `contacts_delete_tags_by_id` | `contactId`               | `{tags: [{tag:"tag1"}]}`                                                   |
| `contacts_add_score`         | `email`                   | `{score: 10}`                                                              |
| `contacts_change_owner`      | `contactId`, `ownerEmail` | —                                                                          |
| `contacts_create_batch`      | —                         | `{contacts:[...], callbackURL:"..."}`                                      |
| `contacts_get_notes`         | `contactId`               | —                                                                          |
| `contacts_get_call_logs`     | `contactId`               | —                                                                          |

#### Companies

| Action                           | Required fields          | `data` shape                                                               |
| -------------------------------- | ------------------------ | -------------------------------------------------------------------------- |
| `companies_list`                 | —                        | —                                                                          |
| `companies_get`                  | `companyId`              | —                                                                          |
| `companies_create`               | —                        | [Company JSON](https://github.com/engagebay/restapi#21-creating-a-company) |
| `companies_update`               | —                        | `{id, properties:[...]}`                                                   |
| `companies_delete`               | `companyId`              | —                                                                          |
| `companies_search`               | `searchQuery`            | —                                                                          |
| `companies_add_contact_by_id`    | `companyId`, `contactId` | —                                                                          |
| `companies_add_contact_by_email` | `companyId`, `email`     | —                                                                          |

#### Deals

| Action                     | Required fields | `data` shape                                     |
| -------------------------- | --------------- | ------------------------------------------------ |
| `deals_list`               | —               | `{trackId: "..."}` (optional)                    |
| `deals_get`                | `dealId`        | —                                                |
| `deals_create`             | —               | `{name, amount, track_name, milestoneLabelName}` |
| `deals_delete`             | `dealId`        | —                                                |
| `deals_create_for_contact` | `email`         | `{name, amount, track_name, milestoneLabelName}` |
| `deals_search`             | `searchQuery`   | —                                                |
| `deals_update_track`       | —               | `{id, milestoneLabelName, track_id}`             |
| `deals_update`             | —               | `{id, properties:[...]}`                         |

#### Tracks

| Action          | Required fields                      |
| --------------- | ------------------------------------ |
| `tracks_list`   | —                                    |
| `tracks_get`    | `trackId`                            |
| `tracks_create` | `data: {name, milestones:[...]}`     |
| `tracks_update` | `data: {id, name, milestones:[...]}` |
| `tracks_delete` | `trackId`                            |

#### Events

| Action                   | Required fields                                                 |
| ------------------------ | --------------------------------------------------------------- |
| `events_list`            | `startTime`, `endTime` (epoch ms)                               |
| `events_get_for_contact` | `contactId`                                                     |
| `events_create`          | `data: {name, start_time, end_time, source_type, owner_id}`     |
| `events_update`          | `data: {id, name, start_time, end_time, source_type, owner_id}` |

#### Tasks

| Action         | Required fields | `data` shape                                                     |
| -------------- | --------------- | ---------------------------------------------------------------- |
| `tasks_list`   | —               | `{taskStatus: "not_started", taskType: "ALL"}`                   |
| `tasks_get`    | `taskId`        | —                                                                |
| `tasks_create` | —               | [Task JSON](https://github.com/engagebay/restapi#63-create-task) |
| `tasks_update` | —               | Task JSON with `id`                                              |
| `tasks_delete` | `taskId`        | —                                                                |

> `taskStatus` values: `not_started`, `in_progress`, `waiting`, `completed`, `deferred`  
> `taskType` values: `TODO`, `EMAIL`, `CALL`, `ALL`

#### Notes

| Action         | `data` shape                   |
| -------------- | ------------------------------ |
| `notes_create` | `{subject, content, parentId}` |

#### Forms

| Action              | Required fields   |
| ------------------- | ----------------- |
| `forms_list`        | —                 |
| `forms_add_contact` | `email`, `formId` |

#### Sequences

| Action                  | Required fields       |
| ----------------------- | --------------------- |
| `sequences_add_contact` | `email`, `sequenceId` |

#### Lists

| Action              | Required fields   |
| ------------------- | ----------------- |
| `lists_list`        | —                 |
| `lists_add_contact` | `email`, `listId` |

#### Owners

| Action        | Required fields |
| ------------- | --------------- |
| `owners_list` | —               |

#### Custom Fields

| Action                 | Required fields                    | `data` shape                                                                      |
| ---------------------- | ---------------------------------- | --------------------------------------------------------------------------------- |
| `custom_fields_list`   | `customFieldType`                  | —                                                                                 |
| `custom_fields_create` | —                                  | `{field_label, scope, field_description, field_type, is_required, is_searchable}` |
| `custom_fields_delete` | `customFieldType`, `customFieldId` | —                                                                                 |

#### User Profile

| Action         | Required fields |
| -------------- | --------------- |
| `user_profile` | —               |

#### Tickets

| Action           | Required fields | `data` shape                                                      |
| ---------------- | --------------- | ----------------------------------------------------------------- |
| `tickets_list`   | —               | `{filterId: "..."}` (optional)                                    |
| `tickets_get`    | `ticketId`      | —                                                                 |
| `tickets_create` | —               | `{requester_name, requester_email, subject, group_id, html_body}` |
| `tickets_delete` | `ticketId`      | —                                                                 |

#### Tags

| Action        | `data` shape     |
| ------------- | ---------------- |
| `tags_list`   | —                |
| `tags_create` | `{tag: "MyTag"}` |

#### Products

| Action                         | Required fields          | `data` shape                                                    |
| ------------------------------ | ------------------------ | --------------------------------------------------------------- |
| `products_list`                | —                        | —                                                               |
| `products_get`                 | `productId`              | —                                                               |
| `products_get_by_name`         | —                        | `{productName: "My Product"}`                                   |
| `products_create`              | —                        | `{name, description, price, discount_type, discount, currency}` |
| `products_update`              | `productId`              | Full product JSON                                               |
| `products_update_partial`      | —                        | `{id, price, name, properties:[...]}`                           |
| `products_delete`              | `productId`              | —                                                               |
| `products_add_to_contact`      | `contactId`              | `{productId, isSubscribed, subscribedOn, interval}`             |
| `products_remove_from_contact` | `contactId`, `productId` | —                                                               |

#### Broadcast

| Action             | `data` shape                                                           |
| ------------------ | ---------------------------------------------------------------------- |
| `broadcast_create` | `{emailIds: [...], template_id: 12345, from_email: "from@domain.com"}` |

### Pagination

For list operations, the actor fetches one page by default (`pageSize` records, max 100). Set `fetchAll: true` to automatically paginate through all pages. Use `cursor` to start from a specific page.

### Output

Results are pushed to the Apify dataset. Each record is a JSON object returned by the EngageBay API.

### Error Handling

| HTTP Status | Meaning                                 |
| ----------- | --------------------------------------- |
| 400         | Bad request — check your `data` payload |
| 401         | Invalid API key                         |
| 404         | Resource not found                      |
| 429         | Rate limit exceeded                     |

### EngageBay REST API Reference

Full API documentation: [https://github.com/engagebay/restapi](https://github.com/engagebay/restapi)

# Actor input Schema

## `apiKey` (type: `string`):

Your EngageBay REST API Key. Find it in Account Admin Settings → API → REST API Key.
## `action` (type: `string`):

The EngageBay API operation to perform.
## `contactId` (type: `string`):

EngageBay Contact ID. Required for: contacts_get, contacts_delete, contacts_list_tags_by_id, contacts_add_tags_by_id, contacts_delete_tags_by_id, contacts_change_owner, contacts_get_notes, contacts_get_call_logs, companies_add_contact_by_id, events_get_for_contact, products_add_to_contact, products_remove_from_contact.
## `companyId` (type: `string`):

EngageBay Company ID. Required for: companies_get, companies_delete, companies_add_contact_by_id, companies_add_contact_by_email.
## `dealId` (type: `string`):

EngageBay Deal ID. Required for: deals_get, deals_delete.
## `trackId` (type: `string`):

EngageBay Track ID. Required for: tracks_get, tracks_delete.
## `taskId` (type: `string`):

EngageBay Task ID. Required for: tasks_get, tasks_delete.
## `ticketId` (type: `string`):

EngageBay Ticket ID. Required for: tickets_get, tickets_delete.
## `productId` (type: `string`):

EngageBay Product ID. Required for: products_get, products_update, products_delete, products_remove_from_contact.
## `formId` (type: `string`):

EngageBay Form ID. Required for: forms_add_contact.
## `sequenceId` (type: `string`):

EngageBay Sequence ID. Required for: sequences_add_contact.
## `listId` (type: `string`):

EngageBay Contact List ID. Required for: lists_add_contact.
## `customFieldType` (type: `string`):

Scope for custom fields. Required for: custom_fields_list, custom_fields_delete.
## `customFieldId` (type: `string`):

EngageBay Custom Field ID. Required for: custom_fields_delete.
## `email` (type: `string`):

Contact email address. Required for email-based actions: contacts_get_by_email, contacts_add_tags, contacts_delete_tags, contacts_list_tags, contacts_add_score, contacts_change_owner, deals_create_for_contact, forms_add_contact, sequences_add_contact, lists_add_contact, companies_add_contact_by_email.
## `ownerEmail` (type: `string`):

New owner's email address. Required for: contacts_change_owner.
## `searchQuery` (type: `string`):

Keyword to search for. Required for: contacts_search, companies_search, deals_search.
## `startTime` (type: `integer`):

Start time as epoch milliseconds. Required for: events_list.
## `endTime` (type: `integer`):

End time as epoch milliseconds. Required for: events_list.
## `pageSize` (type: `integer`):

Number of records to fetch per page for list operations (max 100).
## `sortKey` (type: `string`):

Sort order for list operations. Use 'created_time' or 'updated_time' for ascending, prepend '-' for descending (e.g. '-created_time').
## `cursor` (type: `string`):

Pagination cursor to start from a specific page. Leave empty to start from the beginning.
## `fetchAll` (type: `boolean`):

If true, automatically paginate through all pages and return all results. If false, only fetch one page (up to pageSize records).
## `data` (type: `object`):

JSON object for create/update operations. Also used for action-specific filters (e.g. tasks_list accepts {taskStatus, taskType}; deals_list accepts {trackId}; tickets_list accepts {filterId}). See the README for per-action examples.

## Actor input object example

```json
{
  "pageSize": 20,
  "fetchAll": false,
  "data": {}
}
````

# Actor output Schema

## `results` (type: `string`):

No description

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("sushidata/sushidata-engage-bay").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("sushidata/sushidata-engage-bay").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call sushidata/sushidata-engage-bay --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=sushidata/sushidata-engage-bay",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Engage Bay — Sushidata",
        "description": null,
        "version": "0.0",
        "x-build-id": "nMLRFUT1x0p4FJK5S"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/sushidata~sushidata-engage-bay/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-sushidata-sushidata-engage-bay",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/sushidata~sushidata-engage-bay/runs": {
            "post": {
                "operationId": "runs-sync-sushidata-sushidata-engage-bay",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/sushidata~sushidata-engage-bay/run-sync": {
            "post": {
                "operationId": "run-sync-sushidata-sushidata-engage-bay",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "required": [
                    "apiKey",
                    "action"
                ],
                "properties": {
                    "apiKey": {
                        "title": "API Key",
                        "type": "string",
                        "description": "Your EngageBay REST API Key. Find it in Account Admin Settings → API → REST API Key."
                    },
                    "action": {
                        "title": "Action",
                        "enum": [
                            "contacts_list",
                            "contacts_get",
                            "contacts_get_by_email",
                            "contacts_create",
                            "contacts_update",
                            "contacts_delete",
                            "contacts_search",
                            "contacts_add_tags",
                            "contacts_delete_tags",
                            "contacts_list_tags",
                            "contacts_list_tags_by_id",
                            "contacts_add_tags_by_id",
                            "contacts_delete_tags_by_id",
                            "contacts_add_score",
                            "contacts_change_owner",
                            "contacts_create_batch",
                            "contacts_get_notes",
                            "contacts_get_call_logs",
                            "companies_list",
                            "companies_get",
                            "companies_create",
                            "companies_update",
                            "companies_delete",
                            "companies_search",
                            "companies_add_contact_by_id",
                            "companies_add_contact_by_email",
                            "deals_list",
                            "deals_get",
                            "deals_create",
                            "deals_delete",
                            "deals_create_for_contact",
                            "deals_search",
                            "deals_update_track",
                            "deals_update",
                            "tracks_list",
                            "tracks_get",
                            "tracks_create",
                            "tracks_update",
                            "tracks_delete",
                            "events_list",
                            "events_get_for_contact",
                            "events_create",
                            "events_update",
                            "tasks_list",
                            "tasks_get",
                            "tasks_create",
                            "tasks_update",
                            "tasks_delete",
                            "notes_create",
                            "forms_list",
                            "forms_add_contact",
                            "sequences_add_contact",
                            "lists_list",
                            "lists_add_contact",
                            "owners_list",
                            "custom_fields_list",
                            "custom_fields_create",
                            "custom_fields_delete",
                            "user_profile",
                            "tickets_list",
                            "tickets_get",
                            "tickets_create",
                            "tickets_delete",
                            "tags_list",
                            "tags_create",
                            "products_list",
                            "products_get",
                            "products_get_by_name",
                            "products_create",
                            "products_update",
                            "products_update_partial",
                            "products_delete",
                            "products_add_to_contact",
                            "products_remove_from_contact",
                            "broadcast_create"
                        ],
                        "type": "string",
                        "description": "The EngageBay API operation to perform."
                    },
                    "contactId": {
                        "title": "Contact ID",
                        "type": "string",
                        "description": "EngageBay Contact ID. Required for: contacts_get, contacts_delete, contacts_list_tags_by_id, contacts_add_tags_by_id, contacts_delete_tags_by_id, contacts_change_owner, contacts_get_notes, contacts_get_call_logs, companies_add_contact_by_id, events_get_for_contact, products_add_to_contact, products_remove_from_contact."
                    },
                    "companyId": {
                        "title": "Company ID",
                        "type": "string",
                        "description": "EngageBay Company ID. Required for: companies_get, companies_delete, companies_add_contact_by_id, companies_add_contact_by_email."
                    },
                    "dealId": {
                        "title": "Deal ID",
                        "type": "string",
                        "description": "EngageBay Deal ID. Required for: deals_get, deals_delete."
                    },
                    "trackId": {
                        "title": "Track ID",
                        "type": "string",
                        "description": "EngageBay Track ID. Required for: tracks_get, tracks_delete."
                    },
                    "taskId": {
                        "title": "Task ID",
                        "type": "string",
                        "description": "EngageBay Task ID. Required for: tasks_get, tasks_delete."
                    },
                    "ticketId": {
                        "title": "Ticket ID",
                        "type": "string",
                        "description": "EngageBay Ticket ID. Required for: tickets_get, tickets_delete."
                    },
                    "productId": {
                        "title": "Product ID",
                        "type": "string",
                        "description": "EngageBay Product ID. Required for: products_get, products_update, products_delete, products_remove_from_contact."
                    },
                    "formId": {
                        "title": "Form ID",
                        "type": "string",
                        "description": "EngageBay Form ID. Required for: forms_add_contact."
                    },
                    "sequenceId": {
                        "title": "Sequence ID",
                        "type": "string",
                        "description": "EngageBay Sequence ID. Required for: sequences_add_contact."
                    },
                    "listId": {
                        "title": "List ID",
                        "type": "string",
                        "description": "EngageBay Contact List ID. Required for: lists_add_contact."
                    },
                    "customFieldType": {
                        "title": "Custom Field Type",
                        "enum": [
                            "CONTACT",
                            "DEAL",
                            "COMPANY",
                            "TICKET"
                        ],
                        "type": "string",
                        "description": "Scope for custom fields. Required for: custom_fields_list, custom_fields_delete."
                    },
                    "customFieldId": {
                        "title": "Custom Field ID",
                        "type": "string",
                        "description": "EngageBay Custom Field ID. Required for: custom_fields_delete."
                    },
                    "email": {
                        "title": "Email Address",
                        "type": "string",
                        "description": "Contact email address. Required for email-based actions: contacts_get_by_email, contacts_add_tags, contacts_delete_tags, contacts_list_tags, contacts_add_score, contacts_change_owner, deals_create_for_contact, forms_add_contact, sequences_add_contact, lists_add_contact, companies_add_contact_by_email."
                    },
                    "ownerEmail": {
                        "title": "Owner Email",
                        "type": "string",
                        "description": "New owner's email address. Required for: contacts_change_owner."
                    },
                    "searchQuery": {
                        "title": "Search Query",
                        "type": "string",
                        "description": "Keyword to search for. Required for: contacts_search, companies_search, deals_search."
                    },
                    "startTime": {
                        "title": "Start Time (epoch ms)",
                        "type": "integer",
                        "description": "Start time as epoch milliseconds. Required for: events_list."
                    },
                    "endTime": {
                        "title": "End Time (epoch ms)",
                        "type": "integer",
                        "description": "End time as epoch milliseconds. Required for: events_list."
                    },
                    "pageSize": {
                        "title": "Page Size",
                        "minimum": 1,
                        "maximum": 100,
                        "type": "integer",
                        "description": "Number of records to fetch per page for list operations (max 100).",
                        "default": 20
                    },
                    "sortKey": {
                        "title": "Sort Key",
                        "type": "string",
                        "description": "Sort order for list operations. Use 'created_time' or 'updated_time' for ascending, prepend '-' for descending (e.g. '-created_time')."
                    },
                    "cursor": {
                        "title": "Cursor",
                        "type": "string",
                        "description": "Pagination cursor to start from a specific page. Leave empty to start from the beginning."
                    },
                    "fetchAll": {
                        "title": "Fetch All Pages",
                        "type": "boolean",
                        "description": "If true, automatically paginate through all pages and return all results. If false, only fetch one page (up to pageSize records).",
                        "default": false
                    },
                    "data": {
                        "title": "Request Body / Data",
                        "type": "object",
                        "description": "JSON object for create/update operations. Also used for action-specific filters (e.g. tasks_list accepts {taskStatus, taskType}; deals_list accepts {trackId}; tickets_list accepts {filterId}). See the README for per-action examples.",
                        "default": {}
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```
