> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Sumble: Organizations

> Search, match or enrich companies by filters or a list of domains and names, with the fields you choose, such as technologies and headcount.

Search, match or enrich companies by filters or a list of domains and names, with the fields you choose, such as technologies and headcount.

> [!NOTE]
>
> Tool ID: `sumble_organizations`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'sumble_organizations',
  {
    "select": {
      "attributes": [],
      "entities": []
    }
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute sumble_organizations --input '{
  "select": {
    "attributes": [],
    "entities": []
  }
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "organizations": [
      {
        "input": {
          "name": "Example",
          "url": "https://example.com",
          "location": "example"
        },
        "attributes": {
          "id": 1,
          "slug": "example",
          "name": "Example"
        },
        "entities": []
      }
    ],
    "total": 123
  }
}
```

Use `deepline describe sumble_organizations --json` for the latest machine-readable contract.

## Input reference

Unified organizations endpoint

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.organizations` | `array` | No | — | List of organizations to resolve and enrich. Mutually exclusive with `filter`. Minimum items: 1. Maximum items: 1000. |
| `payload.filter` | `object` | No | — | Advanced query selecting the organizations to return. Mutually exclusive with `organizations`. |
| `payload.select` | `object` | Yes | — | — |
| `payload.limit` | `integer` | No | `10` | Maximum number of results to return. Minimum: 1. Maximum: 200. |
| `payload.offset` | `integer` | No | `0` | Number of results to skip. Minimum: 0. Maximum: 10000. |
| `payload.order_by_column` | `"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" \| null` | No | — | Column to order by (filter mode only). Parameterized sorts (this endpoint only): `people_concentration` and `people_count_growth_1y` sort by the named job function's people metrics — the all-time fraction of the org's tracked people in it, and its current YoY people growth % (latest month vs. one year earlier. orgs without growth data sort last) respectively — and require `order_by_job_function`. `job_post_concentration` sorts by the all-time fraction of the org's job posts matching See the live schema for the complete constraint. |
| `payload.order_by_direction` | `"ASC" \| "DESC"` | No | — | Direction to order by (filter mode only). Allowed: `ASC`, `DESC`. |
| `payload.order_by_job_function` | `string` | No | — | Job function whose people metrics drive the sort. Required with (and only valid with) `order_by_column="people_concentration"` or `order_by_column="people_count_growth_1y"`. |
| `payload.order_by_advanced_query` | `string` | No | — | Advanced query whose matching job posts form the sort numerator. Required with (and only valid with) `order_by_column="job_post_concentration"`. Allowed fields: technology, technology\_category, job\_function, project, job\_level, country. Both the matching and total job counts are all-time. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Unified organizations endpoint",
    "properties": {
      "organizations": {
        "type": [
          "array",
          "null"
        ],
        "description": "List of organizations to resolve and enrich. Mutually exclusive with `filter`.",
        "minItems": 1,
        "maxItems": 1000,
        "items": {
          "type": "object",
          "properties": {
            "name": {
              "type": [
                "string",
                "null"
              ],
              "description": "Organization name"
            },
            "url": {
              "type": [
                "string",
                "null"
              ],
              "description": "Organization website URL or domain"
            },
            "location": {
              "type": [
                "string",
                "null"
              ],
              "description": "Organization location (country name or code)"
            },
            "id": {
              "type": [
                "integer",
                "null"
              ],
              "description": "Organization Id on Sumble. When set, the row identifies a Sumble org directly and bypasses matching; name/url/location are not required."
            },
            "slug": {
              "type": [
                "string",
                "null"
              ],
              "description": "Organization slug on Sumble. When set, the row identifies a Sumble org directly and bypasses matching; name/url/location are not required."
            }
          },
          "additionalProperties": false
        }
      },
      "filter": {
        "type": [
          "object",
          "null"
        ],
        "description": "Advanced query selecting the organizations to return. Mutually exclusive with `organizations`.",
        "properties": {
          "query": {
            "type": "string"
          }
        },
        "required": [
          "query"
        ],
        "additionalProperties": false
      },
      "select": {
        "type": "object",
        "properties": {
          "attributes": {
            "type": "array",
            "description": "Baseline company attributes to include. Off by default.",
            "default": [],
            "items": {
              "type": "string",
              "enum": [
                "id",
                "slug",
                "name",
                "url",
                "employee_count",
                "industry",
                "jobs_count",
                "teams_count",
                "headquarters_country",
                "sumble_score",
                "sumble_url",
                "parent_id",
                "subsidiary_ids",
                "tags",
                "account_status",
                "funding_total_raised",
                "funding_valuation",
                "funding_last_round_raised",
                "funding_last_round_type",
                "funding_last_round_date"
              ]
            }
          },
          "entities": {
            "type": "array",
            "description": "Per-entity metric selections.",
            "default": [],
            "items": {
              "type": "object",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The entity type to enrich against.",
                  "enum": [
                    "job_function",
                    "technology",
                    "project",
                    "advanced_query",
                    "technology_category"
                  ]
                },
                "term": {
                  "type": "string",
                  "description": "The entity term: a technology name, job function, project, category, or advanced query string.",
                  "minLength": 1
                },
                "metrics": {
                  "description": "Metric names valid for `type`, or \"all\". Required for every type.",
                  "anyOf": [
                    {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    {
                      "type": "string",
                      "const": "all"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "granularity": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "`technology_category` only (required there, disallowed elsewhere). `aggregate` rolls the category up into one set of counts; `exploded` decomposes into per-component-technology counts.",
                  "enum": [
                    "aggregate",
                    "exploded"
                  ]
                },
                "since": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Scopes job_post_count, job_post_used_count, team_count, and people_count to activity since this date (YYYY-MM-DD). Does not affect people_count_growth_1y."
                }
              },
              "required": [
                "type",
                "term"
              ],
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "limit": {
        "type": "integer",
        "description": "Maximum number of results to return.",
        "default": 10,
        "minimum": 1,
        "maximum": 200
      },
      "offset": {
        "type": "integer",
        "description": "Number of results to skip.",
        "default": 0,
        "minimum": 0,
        "maximum": 10000
      },
      "order_by_column": {
        "description": "Column to order by (filter mode only). Parameterized sorts (this endpoint only): `people_concentration` and `people_count_growth_1y` sort by the named job function's people metrics — the all-time fraction of the org's tracked people in it, and its current YoY people growth % (latest month vs. one year earlier; orgs without growth data sort last) respectively — and require `order_by_job_function`. `job_post_concentration` sorts by the all-time fraction of the org's job posts matching `order_by_advanced_query`, which it requires. `source_data_url` is omitted for all three, since the listing page cannot reproduce their ordering.",
        "anyOf": [
          {
            "type": "string",
            "enum": [
              "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"
            ]
          },
          {
            "type": "string",
            "enum": [
              "people_concentration",
              "people_count_growth_1y"
            ]
          },
          {
            "type": "string",
            "const": "job_post_concentration"
          },
          {
            "type": "null"
          }
        ]
      },
      "order_by_direction": {
        "type": [
          "string",
          "null"
        ],
        "description": "Direction to order by (filter mode only).",
        "enum": [
          "ASC",
          "DESC"
        ]
      },
      "order_by_job_function": {
        "type": [
          "string",
          "null"
        ],
        "description": "Job function whose people metrics drive the sort. Required with (and only valid with) `order_by_column=\"people_concentration\"` or `order_by_column=\"people_count_growth_1y\"`."
      },
      "order_by_advanced_query": {
        "type": [
          "string",
          "null"
        ],
        "description": "Advanced query whose matching job posts form the sort numerator. Required with (and only valid with) `order_by_column=\"job_post_concentration\"`. Allowed fields: technology, technology_category, job_function, project, job_level, country. Both the matching and total job counts are all-time."
      }
    },
    "required": [
      "select"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.id` | `string` | Yes | — | Format: `uuid`. |
| `result.data.organizations` | `array` | Yes | — | — |
| `result.data.organizations[].input` | `object \| null` | No | — | — |
| `result.data.organizations[].input.name` | `string \| null` | No | — | Organization name |
| `result.data.organizations[].input.url` | `string \| null` | No | — | Organization website URL or domain |
| `result.data.organizations[].input.location` | `string \| null` | No | — | Organization location (country name or code) |
| `result.data.organizations[].input.id` | `integer \| null` | No | — | Organization Id on Sumble. When set, the row identifies a Sumble org directly and bypasses matching. name/url/location are not required. |
| `result.data.organizations[].input.slug` | `string \| null` | No | — | Organization slug on Sumble. When set, the row identifies a Sumble org directly and bypasses matching. name/url/location are not required. |
| `result.data.organizations[].attributes` | `object \| null` | No | — | — |
| `result.data.organizations[].attributes.id` | `integer \| null` | No | — | — |
| `result.data.organizations[].attributes.slug` | `string \| null` | No | — | — |
| `result.data.organizations[].attributes.name` | `string \| null` | No | — | — |
| `result.data.organizations[].attributes.url` | `string \| null` | No | — | — |
| `result.data.organizations[].attributes.employee_count` | `integer \| null` | No | — | — |
| `result.data.organizations[].attributes.industry` | `string \| null` | No | — | — |
| `result.data.organizations[].attributes.jobs_count` | `integer \| null` | No | — | — |
| `result.data.organizations[].attributes.teams_count` | `integer \| null` | No | — | — |
| `result.data.organizations[].attributes.headquarters_country` | `string \| null` | No | — | — |
| `result.data.organizations[].attributes.sumble_score` | `number \| null` | No | — | — |
| `result.data.organizations[].attributes.sumble_url` | `string \| null` | No | — | — |
| `result.data.organizations[].attributes.parent_id` | `integer \| null` | No | — | — |
| `result.data.organizations[].attributes.subsidiary_ids` | `array \| null` | No | — | — |
| `result.data.organizations[].attributes.tags` | `array \| null` | No | — | — |
| `result.data.organizations[].attributes.account_status` | `"is_customer" \| "is_in_crm" \| "is_not_in_crm"` | No | — | CRM relationship between the org and the user's account: 'is\_customer' (a customer account in the user's CRM), 'is\_in\_crm' (tracked in CRM but not a customer), or 'is\_not\_in\_crm' (no CRM record). Free (no credit cost). Only populated when the user's account has a linked CRM seat. omitted for other users even if requested. Allowed: `is_customer`, `is_in_crm`, `is_not_in_crm`. |
| `result.data.organizations[].attributes.funding_total_raised` | `integer \| null` | No | — | Total funding raised across all rounds, in whole USD. LLM-extracted from SEC filings and web search. approximate, and may be unconverted for non-USD rounds. |
| `result.data.organizations[].attributes.funding_valuation` | `integer \| null` | No | — | Most recent post-money valuation, in whole USD. LLM-extracted. approximate. |
| `result.data.organizations[].attributes.funding_last_round_raised` | `integer \| null` | No | — | Amount raised in the latest funding round, in whole USD. LLM-extracted. approximate. |
| `result.data.organizations[].attributes.funding_last_round_type` | `string \| null` | No | — | Latest funding round type, e.g. seed, series\_a, private\_equity. |
| `result.data.organizations[].attributes.funding_last_round_date` | `string \| null` | No | — | Date of the latest funding round (ISO YYYY-MM-DD). Format: `date`. |
| `result.data.organizations[].attributes.cloud_spend_estimate_millions_usd` | `number \| null` | No | — | — |
| `result.data.organizations[].entities` | `array` | No | `[]` | — |
| `result.data.organizations[].entities[].type` | `"job_function" \| "technology" \| "project" \| "advanced_query" \| "technology_category"` | Yes | — | Allowed: `job_function`, `technology`, `project`, `advanced_query`, `technology_category`. |
| `result.data.organizations[].entities[].term` | `string` | Yes | — | — |
| `result.data.organizations[].entities[].job_post_count` | `integer \| null` | No | — | — |
| `result.data.organizations[].entities[].job_post_count_url` | `string \| null` | No | — | — |
| `result.data.organizations[].entities[].job_post_used_count` | `integer \| null` | No | — | technology only. Number of the org's job posts that list this technology as actively used (rather than merely mentioned). Scoped to the same `since` window as job\_post\_count when set. None for non-technology entities. |
| `result.data.organizations[].entities[].team_count` | `integer \| null` | No | — | — |
| `result.data.organizations[].entities[].team_count_url` | `string \| null` | No | — | — |
| `result.data.organizations[].entities[].people_count` | `integer \| null` | No | — | — |
| `result.data.organizations[].entities[].people_count_url` | `string \| null` | No | — | — |
| `result.data.organizations[].entities[].job_post_concentration` | `number \| null` | No | — | advanced\_query only. Fraction (0-1) of the org's job posts matching the query. Scoped to the same `since` window as job\_post\_count when set. None for unresolved orgs or orgs with no job posts. |
| `result.data.organizations[].entities[].people_concentration` | `number \| null` | No | — | job\_function only. Fraction (0-1) of the org's tracked people in this job function: people\_count / total people in the org. Scoped to the same `since` window as people\_count when set. None for unresolved orgs or orgs with no tracked people. |
| `result.data.organizations[].entities[].people_count_growth_1y` | `number \| null` | No | — | — |
| `result.data.organizations[].entities[].people_count_growth_1y_url` | `string \| null` | No | — | — |
| `result.data.organizations[].entities[].job_post_count_growth_1y` | `number \| null` | No | — | — |
| `result.data.organizations[].entities[].job_post_count_growth_1y_url` | `string \| null` | No | — | — |
| `result.data.organizations[].entities[].granularity` | `"aggregate" \| "exploded"` | No | — | Allowed: `aggregate`, `exploded`. |
| `result.data.organizations[].entities[].components` | `array \| null` | No | — | — |
| `result.data.matched_count` | `integer \| null` | No | — | — |

The table shows the first 50 fields. Expand the raw schema below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe sumble_organizations --json`.

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Sumble provider guide](https://deepline.com/docs/providers/sumble/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.