> ## 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: Match Organizations

> Match a list of companies by name, website and location to their company records. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Match a list of companies by name, website and location to their company records.

> [!NOTE]
>
> Tool ID: `sumble_match_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_match_organizations',
  {
    "organizations": [
      {
        "name": "Example",
        "url": "https://example.com",
        "location": "example"
      }
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute sumble_match_organizations --input '{
  "organizations": [
    {
      "name": "Example",
      "url": "https://example.com",
      "location": "example"
    }
  ]
}' --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",
    "results": [
      {
        "input": {
          "name": "Example",
          "url": "https://example.com",
          "location": "example"
        }
      }
    ],
    "matched_count": 123,
    "total": 123
  }
}
```

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

## Input reference

Match a list of organizations

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.organizations` | `array` | Yes | — | List of organizations to match Minimum items: 1. Maximum items: 1000. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Match a list of organizations",
    "properties": {
      "organizations": {
        "type": "array",
        "description": "List of organizations to match",
        "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
        }
      }
    },
    "required": [
      "organizations"
    ],
    "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.results` | `array` | Yes | — | — |
| `result.data.results[].input` | `object` | Yes | — | — |
| `result.data.results[].input.name` | `string \| null` | No | — | Organization name |
| `result.data.results[].input.url` | `string \| null` | No | — | Organization website URL or domain |
| `result.data.results[].input.location` | `string \| null` | No | — | Organization location (country name or code) |
| `result.data.results[].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.results[].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.results[].match` | `object \| null` | No | — | — |
| `result.data.results[].match.id` | `integer` | Yes | — | — |
| `result.data.results[].match.slug` | `string` | Yes | — | — |
| `result.data.results[].match.name` | `string` | Yes | — | — |
| `result.data.results[].match.domain` | `string` | Yes | — | — |
| `result.data.matched_count` | `integer` | Yes | — | — |
| `result.data.total` | `integer` | Yes | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "input": {
                  "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
                },
                "match": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "id": {
                      "type": "integer"
                    },
                    "slug": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "domain": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "slug",
                    "name",
                    "domain"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "input"
              ],
              "additionalProperties": false
            }
          },
          "matched_count": {
            "type": "integer"
          },
          "total": {
            "type": "integer"
          }
        },
        "required": [
          "id",
          "results",
          "matched_count",
          "total"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

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