{ "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 } } } } } } } } } }