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

# Sumble

Sumble provides company and people search, enrichment, technology intelligence, and business signals for go-to-market workflows.

- **Category:** ai sales tools
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 34
- **Triggers:** 0
- **Slug:** `SUMBLE`
- **Version:** 00000000_00

## Tools

### Add Organizations to List

**Slug:** `SUMBLE_ADD_ORGANIZATIONS_TO_LIST`

Add companies to an organization list by Sumble IDs or slugs and return added IDs plus invalid inputs. Existing members are skipped. This free mutation changes persistent private targeting membership.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | Sumble organization-list ID whose membership to update. |
| `organization_ids` | array | No | Sumble organization IDs to add. |
| `organization_slugs` | array | No | Canonical Sumble organization slugs to add. |

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

### Add People to Contact List

**Slug:** `SUMBLE_ADD_PEOPLE_TO_CONTACT_LIST`

Add 1 to 10,000 Sumble person IDs to a saved contact list and report newly added versus already-present counts. This free persistent mutation stores sensitive people-list membership. Free and Pro lists are capped at 10,000 total members; an over-limit request fails atomically with contact_list_full.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | Sumble contact-list ID whose persistent membership to update. |
| `people_ids` | array | Yes | Between 1 and 10,000 Sumble person IDs to add. Existing members are silently skipped. These IDs represent sensitive saved-list membership. |

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

**Slug:** `SUMBLE_CREATE_CONTACT_LIST`

Create a persistent empty contact list and return its ID and Sumble URL. This free mutation creates private account state and does not reveal contact PII.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Private name for the new empty contact 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 |

### Create Data Quality Report

**Slug:** `SUMBLE_CREATE_DATA_QUALITY_REPORT`

Email Sumble's data team immediately about incorrect, missing, or stale data. This free, irreversible, sensitive external communication sends user-provided issue text, a URL, and a page title outside Composio and uses the connected account email as reply-to.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Related Sumble URL, if any; omit or send null when none applies. |
| `message` | string | Yes | Description of incorrect, missing, or stale data to email immediately to Sumble's data team. |
| `page_title` | string | No | Title of the related Sumble page; omit or send null when unavailable. |

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

**Slug:** `SUMBLE_CREATE_ORGANIZATION_LIST`

Create a persistent empty organization list and return its ID and Sumble URL. This free mutation creates private account state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the new organization 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 |

### Create Support Request

**Slug:** `SUMBLE_CREATE_SUPPORT_REQUEST`

Send an account, billing, or product request to Sumble support by external email immediately. This free, irreversible, sensitive communication sends user-provided text and a URL outside Composio and uses the connected account email as reply-to.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Related Sumble URL, if any; omit or send null when none applies. |
| `message` | string | Yes | Account, billing, or product request to email immediately to Sumble's support inbox. The connected account email is used as reply-to. |

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

### Find Locations

**Slug:** `SUMBLE_FIND_LOCATIONS`

Search Sumble location names, list a location's children, or list top-level locations and return exact case-sensitive filter codes. Region codes work only in organization filters; before using a region in a people filter, pass the region code as parent and use the returned country codes. This billable read costs one credit when at least one location is returned; requests with no matches cost no credits.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Nonblank place name or alias to search; mutually exclusive with parent. |
| `parent` | string | No | Exact case-sensitive returned location code whose children to list; mutually exclusive with query. Unknown and city codes are rejected. |

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

### Find Technologies

**Slug:** `SUMBLE_FIND_TECHNOLOGIES`

Search Sumble's technology catalog by a partial name and return up to 50 canonical slugs for company, people, or signal filters. A request costs one credit only when at least one technology is returned. When file_name is set, the response contains file metadata instead of inline technologies; the download URL requires the file owner's authenticated Sumble session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Technology name or partial name to search in Sumble's catalog. |
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. |

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

**Slug:** `SUMBLE_GET_COMPANY_SIGNALS`

Return recent Sumble signals for one company, optionally restricted to explicit canonical technology slugs. Signals can include suggested-contact profile data and connected-account CRM relationship status. This billable read consumes one credit per returned signal; no returned signals consume no credits. When file_name is set, the response contains file metadata instead of inline signals; the download URL requires the file owner's authenticated Sumble session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. When set, the returned download URL requires an authenticated Sumble web session. |
| `organization_id` | integer | Yes | Sumble organization ID whose recent signals to return. |
| `technology_slugs` | array | No | Canonical technology slugs used to filter signals. Obtain them with Find Technologies or Lookup Technologies. Multiple values are sent as repeated query parameters. |

#### 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 Company Tech Stack

**Slug:** `SUMBLE_GET_COMPANY_TECH_STACK`

Return technologies Sumble confirms a company uses, grouped by business function and category. This billable read consumes one credit per primary technology returned; companies with no confirmed technologies consume no credits. When file_name is set, the response contains file metadata instead of inline business functions; the download URL requires the file owner's authenticated Sumble session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. When set, the returned download URL requires an authenticated Sumble web session. |
| `organization_id` | integer | Yes | Sumble organization ID whose confirmed technology stack to return. |

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

**Slug:** `SUMBLE_GET_CONTACT_LIST`

Get one private contact list and its enriched people, including available email and phone PII. This billable, sensitive read costs one credit per person. When file_name is set, authenticated-download metadata replaces inline people.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | Sumble contact-list ID to retrieve. |
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. The generated file can contain sensitive profile and contact PII, and its download URL requires the owner's authenticated Sumble web session. |

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

**Slug:** `SUMBLE_GET_CONVERSATION`

Read one caller-owned Ask Sumble transcript page in saved message order, including private message text, attachment names, expiring generated-file links, and per-message accounting metadata. This free, highly sensitive read does not charge recorded credits again and never fetches additional transcript pages automatically.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_offset` | integer | No | Zero-based message offset returned as next_message_offset. Use 0 for the first transcript page. |
| `conversation_id` | string | Yes | Conversation UUID from List Conversations. |

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

**Slug:** `SUMBLE_GET_INTELLIGENCE_BRIEF`

Retrieve or irreversibly start a Sumble AI intelligence brief for one organization. A completed brief costs 50 credits and can contain sensitive account strategy, contacts, teams, and technology intelligence. A pending response is free; this action returns it immediately and never polls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_id` | integer | Yes | Sumble organization ID whose AI intelligence brief to retrieve or start. |

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

**Slug:** `SUMBLE_GET_ORGANIZATION_LIST`

Get one saved organization list and its companies, optionally including a deleted list or returning the rows as a file. This sensitive, billable read costs one credit per company returned and can expose private targeting and CRM data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | Sumble organization-list ID to retrieve. |
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. When set, organizations is empty and file contains authenticated download metadata. |
| `include_deleted` | boolean | No | Allow retrieval when the requested list is soft-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 |

### List Contact Lists

**Slug:** `SUMBLE_LIST_CONTACT_LISTS`

List saved people lists with IDs, private names, counts, and URLs. This billable, sensitive read costs one credit per returned list. When file_name is set, the response contains authenticated-download metadata and no inline rows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. The generated file's download URL requires the owner's authenticated Sumble web session. |

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

**Slug:** `SUMBLE_LIST_CONVERSATIONS`

List the caller's private Ask Sumble conversations, newest updated first, with one-based page continuation. This free, sensitive read returns only caller-owned conversation metadata and never fetches additional pages automatically.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | One-based page number. Each page contains up to 30 conversations. |

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

**Slug:** `SUMBLE_LIST_ORGANIZATION_LISTS`

List saved organization lists, optionally including soft-deleted lists. This billable read costs one credit per list returned and can expose private list names, counts, URLs, and settings. It can return a downloadable file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. When set, organization_lists is empty and file contains authenticated download metadata. |
| `include_deleted` | boolean | No | Include soft-deleted organization lists. |

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

**Slug:** `SUMBLE_LIST_SIGNAL_CONFIGS`

List visible standing signal rules or look up authorized historical config IDs. This free but sensitive read exposes account-, customer-, or domain-scoped monitoring rules and filters. It is unpaginated and can return file metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filter` | object | No | Optional active-listing filters or a historical ID lookup. |
| `file_name` | string | No | Optional .csv, .xlsx, or .json filename. File output replaces inline configs and requires an authenticated Sumble session to download. |

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

### Lookup Job Titles

**Slug:** `SUMBLE_LOOKUP_JOB_TITLES`

Classify 1 to 1000 raw job titles into Sumble job functions and levels for people or company filters. This billable read costs one credit per 100 titles matched to at least one classification; unmatched titles are free. When file_name is set, the response contains file metadata instead of inline results; the download URL requires the file owner's authenticated Sumble session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `titles` | array | Yes | Raw job titles to classify. Results align one-to-one with this list in the same order. |
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. |

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

### Lookup Projects

**Slug:** `SUMBLE_LOOKUP_PROJECTS`

Resolve project names or slugs to canonical Sumble projects for company query filters. This billable read consumes one credit per 100 matched projects; unmatched inputs do not consume credits. When file_name is set, the response contains file metadata instead of inline results; the download URL requires the file owner's authenticated Sumble session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projects` | array | Yes | Project names or slugs to canonicalize. Results are returned in the same order and align one-to-one with this list. |
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. |

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

### Lookup Technologies

**Slug:** `SUMBLE_LOOKUP_TECHNOLOGIES`

Resolve known technology names, slugs, or aliases to canonical Sumble technologies in input order. This billable read costs one credit per 100 matched technologies; unmatched inputs consume no credits. When file_name is set, the response contains file metadata instead of inline results; the download URL requires the file owner's authenticated Sumble session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. |
| `technologies` | array | Yes | Technology names, slugs, or aliases to resolve. Supply 1-1000 values; results are returned in the same order. |

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

### Lookup Technology Categories

**Slug:** `SUMBLE_LOOKUP_TECHNOLOGY_CATEGORIES`

Resolve technology category names or slugs and enumerate their canonical technologies for Sumble company filters. This billable read costs one credit per 100 matched categories; unmatched inputs consume no credits. When file_name is set, the response contains file metadata instead of inline results; the download URL requires the file owner's authenticated Sumble session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. |
| `technology_categories` | array | Yes | Technology category names or slugs to resolve. Results align one-to-one with this list in the same order. |

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

### Rename Organization List

**Slug:** `SUMBLE_RENAME_ORGANIZATION_LIST`

Rename a user-owned organization list without changing its membership. This free persistent mutation cannot rename read-only group lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New list name, from 1 to 255 characters. |
| `list_id` | integer | Yes | Sumble organization-list ID to rename. |

#### 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 and Enrich Companies

**Slug:** `SUMBLE_SEARCH_AND_ENRICH_COMPANIES`

Match known companies or search Sumble companies and return only explicitly selected firmographic and entity metrics. This billable, sensitive read can expose CRM relationship data and consumes credits per returned company, paid attribute, and metric.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum companies in this page (1-200). |
| `filter` | object | No | Advanced-query expression for company search. Supply exactly one of filter or organizations. |
| `offset` | integer | No | Companies to skip for this page (0-10000). |
| `select` | object | Yes | Attributes and entity metrics to return. Paid selections determine the credit cost. |
| `file_name` | string | No | Optional output filename ending in .csv, .xlsx, or .json. File output replaces inline rows, and its URL requires the owner's authenticated Sumble web session. |
| `match_source` | string ("any" | "job_post") | No | In filter mode, allow employee or job-post evidence with 'any', or only job-post evidence with 'job_post'. |
| `organizations` | array | No | Companies to match directly. Supply exactly one of organizations or filter. Each entry uses id, slug, or name/url with optional location. |
| `include_closed` | boolean | No | In filter mode, include permanently closed companies. Invalid in direct match mode. |
| `order_by_column` | string ("industry" | "employee_count" | "employee_count_int" | "first_activity_time" | "last_activity_time" | "jobs_count" | "teams_count" | "people_count" | "jobs_count_growth_6mo" | "cloud_spend_estimate_millions_usd" | "account_score" | "people_concentration" | "people_count_growth_1y" | "job_post_concentration") | No | Filter-mode sort column. Parameterized concentration and growth sorts require their corresponding order-by input. |
| `order_by_direction` | string ("ASC" | "DESC") | No | Filter-mode sort direction: ASC or DESC. |
| `order_by_job_function` | string | No | Job function required only when sorting by people_concentration or people_count_growth_1y. |
| `order_by_advanced_query` | string | No | Advanced query required only when sorting by job_post_concentration. |

#### 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 and Enrich Jobs

**Slug:** `SUMBLE_SEARCH_AND_ENRICH_JOBS`

Match job-post IDs or search Sumble job posts and return explicitly selected details, extracted entities, and related people. This billable, sensitive read costs one base credit per matched or returned job, plus one per paid attribute and related person; full descriptions and inferred relationships can contain sensitive business data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jobs` | array | No | Job IDs to resolve in input order. Supply exactly one of jobs or filter. |
| `limit` | integer | No | Filter-mode page size (1-200); ignored in list mode. |
| `filter` | object | No | Search criteria. Supply exactly one of filter or jobs. |
| `offset` | integer | No | Filter-mode result offset (0-10000); ignored in list mode. |
| `select` | object | Yes | Explicit job attributes and related people to return and bill. |
| `file_name` | string | No | Optional .csv, .xlsx, or .json output filename. File mode costs the same as inline output and returns an authenticated download URL. |

#### 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 and Enrich People

**Slug:** `SUMBLE_SEARCH_AND_ENRICH_PEOPLE`

Start or poll Sumble's asynchronous people match/search and return only explicitly selected attributes. This is a billable, PII-sensitive read: email reveal costs 10 credits, phone reveal 80 credits, and reverse lookup costs 20 credits per resolved input email. Contact fields are never inferred or added; poll by invoking this action again with request_id alone. When file_name is set, successful file creation replaces inline people with an authenticated-session download; file-write failure falls back to inline rows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Filter-mode page size from 1 to 200; the provider default is 10. Omit when polling. |
| `filter` | object | No | Start mode only: supply exactly one of filter or people, and also supply select. This structured-query or limited-beta natural-language search can process sensitive location and employment-history criteria. |
| `offset` | integer | No | Filter-mode result offset from 0 to 10000. Omit when polling. |
| `people` | array | No | Start mode only: supply exactly one of people or filter, and also supply select. Resolve these people by explicit person_id, LinkedIn URL, or work email. Base cost is 1 credit per match; an explicitly supplied email can cost exactly 20 credits when resolved and is sensitive PII. Requests involving email identifiers, contact attributes, or related people are capped at 25; explicit experience or summary profile attributes are capped at 200. |
| `select` | object | No | Required in start mode with exactly one of people or filter; omit when polling. Contact PII is never added automatically: email costs exactly 10 credits on first reveal and phone exactly 80; each paid profile attribute costs 1 credit per returned person. |
| `file_name` | string | No | Start only: output filename ending in .csv, .xlsx, or .json. The resulting file may contain sensitive person/contact PII; its URL requires the owner's authenticated Sumble session. File creation has no separate documented cost. |
| `request_id` | string | No | Poll mode only: async request ID from a prior start. Polling is free and, when supplied, this must be the only non-null request field. |
| `order_by_column` | string ("person_score" | "start_date" | "job_level") | No | Filter-mode sort column. person_score costs the same exact 1 credit as a paid attribute on every row and requires one organization plus an ICP. |
| `requested_total` | integer | No | Natural-language search only: maximum ranked people across all pages, from 1 to 1000. Keep it unchanged while paging; it defaults to limit. |
| `order_by_direction` | string ("ASC" | "DESC") | No | Filter-mode sort direction; Sumble defaults to DESC. |

#### 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 and Enrich Teams

**Slug:** `SUMBLE_SEARCH_AND_ENRICH_TEAMS`

Match team IDs or search teams within specified organizations and return selected team attributes, related people, and job posts. This billable, sensitive read costs one base credit per matched or returned team, plus one per paid attribute, related person, and job post, and exposes inferred organization and team relationships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Filter-mode page size (1-200); ignored in list mode. |
| `teams` | array | No | Sumble team IDs to resolve in input order. Supply exactly one of teams or filter. |
| `filter` | object | No | Organization-scoped search criteria. Supply exactly one of filter or teams. |
| `offset` | integer | No | Filter-mode result offset (0-10000); ignored in list mode. |
| `select` | object | Yes | Explicit team attributes, related people, and job posts to return and bill. |
| `order_by_column` | string ("jobs_count" | "first_activity" | "last_activity" | "score") | No | Filter-mode team sort column. |
| `order_by_direction` | string ("ASC" | "DESC") | No | Filter-mode sort direction; Sumble defaults to DESC. |

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

**Slug:** `SUMBLE_SEARCH_DOCUMENTATION`

Search Sumble product documentation using a few words or a short question and return matching paths, titles, excerpts, and published URLs. This read is free. The query is sent to Sumble and may contain sensitive text.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum matching documentation entries to return, from 1 to 10. Defaults to 5. |
| `query` | string | Yes | A few search words or a short question. Sumble searches case-insensitively and accounts for common English word forms. Must contain 1 to 500 characters. |

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

**Slug:** `SUMBLE_SEARCH_PRIORITY_SIGNALS`

Search Sumble priority-signal digest items by source entities and existing relevance or written feedback. This sensitive, billable read returns private feedback and AI-generated account intelligence and costs one credit per item. Results are one offset page ordered by completion time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum priority signals in this page (1-100). |
| `filter` | object | No | Optional filters combined with AND; values within arrays use OR. |
| `offset` | integer | No | Priority signals to skip in completion order. |
| `file_name` | string | No | Optional .csv, .xlsx, or .json filename. File output replaces inline priority signals and requires an authenticated Sumble session to download. |

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

**Slug:** `SUMBLE_SEARCH_SIGNALS`

Search recent Sumble signals across visible accounts by organizations, people, technologies, priorities, lists, configs, or exact signal IDs. This sensitive, billable read can expose CRM status and suggested contacts and costs one credit per returned signal. Results are one deterministic newest-first offset page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum signals in this page (1-100). |
| `filter` | object | No | Optional filters combined with AND; values within each array use OR. |
| `offset` | integer | No | Signals to skip in newest-first order. |
| `file_name` | string | No | Optional .csv, .xlsx, or .json filename. File output replaces inline signals and requires an authenticated Sumble session to download. |

#### 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 or Restore Organization List

**Slug:** `SUMBLE_SET_ORGANIZATION_LIST_DELETED`

Soft-delete or restore an organization list while preserving its companies. This free persistent mutation is reversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deleted` | boolean | Yes | True to soft-delete the list, or false to restore it. |
| `list_id` | integer | Yes | Sumble organization-list ID to soft-delete or restore. |

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

### Set Organization List Signals

**Slug:** `SUMBLE_SET_ORGANIZATION_LIST_SIGNALS`

Include or exclude an organization list's companies from future Signals delivery. This free mutation changes ongoing account behavior.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | Sumble organization-list ID whose Signals setting to change. |
| `include_in_signals` | boolean | Yes | True to include the list's companies in Signals, or false to exclude 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 |

### Update Priority Signal Feedback

**Slug:** `SUMBLE_UPDATE_PRIORITY_SIGNAL_FEEDBACK`

Replace or clear private written feedback on a priority signal. This free, sensitive persistent mutation affects future priority signals and Ask Sumble behavior. Empty text or null clears the prior value.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | Yes | Priority-signal digest item ID to update. |
| `feedback` | string | Yes | Replacement written feedback of at most 2,000 characters. Send null or an empty string to clear prior feedback. |

#### 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 Priority Signal Relevance

**Slug:** `SUMBLE_UPDATE_PRIORITY_SIGNAL_RELEVANCE`

Mark a priority signal relevant or not relevant, or clear the relevance value. This free persistent mutation affects feedback used to generate future digests.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | Yes | Priority-signal digest item ID to update. |
| `is_relevant` | string | Yes | True for relevant, false for not relevant, or null to clear the rating. |

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