> ## 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: Inputs, Cost & CLI Example
> Unified organizations endpoint. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=sumble_organizations:{"select":{}}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.organizations` | `array` | No | | List of organizations to resolve and enrich. Mutually exclusive with `filter`. |
| `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. |
| `payload.offset` | `integer` | No | `0` | Number of results to skip. |
| `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 `order_by_advanced_query`, which it requires. `source_data_url` is omitted for all three, since the listing page cannot reproduce their ordering. |
| `payload.order_by_direction` | `"ASC" \| "DESC"` | No | | Direction to order by (filter mode only). |
| `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. |
### Allowed values
| Field | Allowed values |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `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` |
| `payload.order_by_direction` | `ASC`, `DESC` |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"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
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"organizations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"input": {
"type": [
"object",
"null"
],
"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
},
"attributes": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"slug": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
},
"employee_count": {
"type": [
"integer",
"null"
]
},
"industry": {
"type": [
"string",
"null"
]
},
"jobs_count": {
"type": [
"integer",
"null"
]
},
"teams_count": {
"type": [
"integer",
"null"
]
},
"headquarters_country": {
"type": [
"string",
"null"
]
},
"sumble_score": {
"type": [
"number",
"null"
]
},
"sumble_url": {
"type": [
"string",
"null"
]
},
"parent_id": {
"type": [
"integer",
"null"
]
},
"subsidiary_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
}
},
"tags": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"account_status": {
"type": [
"string",
"null"
],
"description": "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.",
"enum": [
"is_customer",
"is_in_crm",
"is_not_in_crm"
]
},
"funding_total_raised": {
"type": [
"integer",
"null"
],
"description": "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."
},
"funding_valuation": {
"type": [
"integer",
"null"
],
"description": "Most recent post-money valuation, in whole USD. LLM-extracted; approximate."
},
"funding_last_round_raised": {
"type": [
"integer",
"null"
],
"description": "Amount raised in the latest funding round, in whole USD. LLM-extracted; approximate."
},
"funding_last_round_type": {
"type": [
"string",
"null"
],
"description": "Latest funding round type, e.g. seed, series_a, private_equity."
},
"funding_last_round_date": {
"type": [
"string",
"null"
],
"description": "Date of the latest funding round (ISO YYYY-MM-DD).",
"format": "date"
},
"cloud_spend_estimate_millions_usd": {
"type": [
"number",
"null"
]
}
},
"additionalProperties": false
},
"entities": {
"type": "array",
"default": [],
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"job_function",
"technology",
"project",
"advanced_query",
"technology_category"
]
},
"term": {
"type": "string"
},
"job_post_count": {
"type": [
"integer",
"null"
]
},
"job_post_count_url": {
"type": [
"string",
"null"
]
},
"job_post_used_count": {
"type": [
"integer",
"null"
],
"description": "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."
},
"team_count": {
"type": [
"integer",
"null"
]
},
"team_count_url": {
"type": [
"string",
"null"
]
},
"people_count": {
"type": [
"integer",
"null"
]
},
"people_count_url": {
"type": [
"string",
"null"
]
},
"job_post_concentration": {
"type": [
"number",
"null"
],
"description": "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."
},
"people_concentration": {
"type": [
"number",
"null"
],
"description": "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."
},
"people_count_growth_1y": {
"type": [
"number",
"null"
]
},
"people_count_growth_1y_url": {
"type": [
"string",
"null"
]
},
"job_post_count_growth_1y": {
"type": [
"number",
"null"
]
},
"job_post_count_growth_1y_url": {
"type": [
"string",
"null"
]
},
"granularity": {
"type": [
"string",
"null"
],
"enum": [
"aggregate",
"exploded"
]
},
"components": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"description": "Recursive OpenAPI schema reference #/components/schemas/EntityResult.",
"additionalProperties": true
}
}
},
"required": [
"type",
"term"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"matched_count": {
"type": [
"integer",
"null"
]
},
"total": {
"type": "integer"
},
"source_data_url": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 2083,
"format": "uri"
}
},
"required": [
"id",
"organizations",
"total"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute sumble_organizations --payload '{
"select": {}
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.