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

# Fundable: Search Locations

> Search locations by name and optionally filter by type. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Search locations by name and optionally filter by type.

<Info>
  Tool ID: `fundable_search_locations`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'fundable_search_locations',
  {
    "name": "Example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute fundable_search_locations --input '{
  "name": "Example"
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "success": true,
    "data": {
      "locations": [
        {
          "permalink": "example",
          "name": "Example",
          "location_type": "REGION"
        }
      ]
    },
    "meta": {
      "total_count": 123,
      "page": 123,
      "page_size": 123
    }
  }
}
```

Use `deepline tools get fundable_search_locations --json` for the latest machine-readable contract.

## Input reference

Use this endpoint to resolve a human-readable city, state, country, or region into the exact permalink required by location filters on discovery endpoints. Agents should not guess permalinks. Select the result that matches the user's intended geography, then pass its permalink to the relevant filter. The `name` parameter is required; `type` is optional. **Search types:** - `name` — Fuzzy name search with relevance scoring (required) - `type` — Optional filter by location type: `CITY`, `STATE`, `REGION`, or `COUNTRY` - `location_type` — Alias for `type` Examples: - `?name=san francisco` - `?name=california&type=STATE`

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.name` | `string` | Yes | — | Location name to search for |
| `payload.type` | `"CITY" \| "STATE" \| "REGION" \| "COUNTRY"` | No | — | Filter by specific location type Allowed: `CITY`, `STATE`, `REGION`, `COUNTRY`. |
| `payload.location_type` | `"CITY" \| "STATE" \| "REGION" \| "COUNTRY"` | No | — | Alias for 'type' parameter Allowed: `CITY`, `STATE`, `REGION`, `COUNTRY`. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Use this endpoint to resolve a human-readable city, state, country, or region into the exact permalink required by location filters on discovery endpoints. Agents should not guess permalinks. Select the result that matches the user's intended geography, then pass its permalink to the relevant filter. The `name` parameter is required; `type` is optional. **Search types:** - `name` — Fuzzy name search with relevance scoring (required) - `type` — Optional filter by location type: `CITY`, `STATE`, `REGION`, or `COUNTRY` - `location_type` — Alias for `type` Examples: - `?name=san francisco` - `?name=california&type=STATE`",
    "properties": {
      "name": {
        "type": "string",
        "description": "Location name to search for"
      },
      "type": {
        "type": "string",
        "description": "Filter by specific location type",
        "enum": [
          "CITY",
          "STATE",
          "REGION",
          "COUNTRY"
        ]
      },
      "location_type": {
        "type": "string",
        "description": "Alias for 'type' parameter",
        "enum": [
          "CITY",
          "STATE",
          "REGION",
          "COUNTRY"
        ]
      }
    },
    "required": [
      "name"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.success` | `boolean` | Yes | — | — |
| `result.data.data` | `object` | Yes | — | — |
| `result.data.data.locations` | `array` | No | — | — |
| `result.data.data.locations[].permalink` | `string` | No | — | Location permalink identifier |
| `result.data.data.locations[].name` | `string` | No | — | Location name |
| `result.data.data.locations[].location_type` | `"REGION" \| "COUNTRY" \| "STATE" \| "CITY"` | No | — | Type of location Allowed: `REGION`, `COUNTRY`, `STATE`, `CITY`. |
| `result.data.meta` | `object` | Yes | — | — |
| `result.data.meta.total_count` | `integer` | No | — | Number of locations returned |
| `result.data.meta.page` | `integer` | No | — | — |
| `result.data.meta.page_size` | `integer` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "type": "object",
            "properties": {
              "locations": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "permalink": {
                      "type": "string",
                      "description": "Location permalink identifier"
                    },
                    "name": {
                      "type": "string",
                      "description": "Location name"
                    },
                    "location_type": {
                      "type": "string",
                      "description": "Type of location",
                      "enum": [
                        "REGION",
                        "COUNTRY",
                        "STATE",
                        "CITY"
                      ]
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          },
          "meta": {
            "type": "object",
            "properties": {
              "total_count": {
                "type": "integer",
                "description": "Number of locations returned"
              },
              "page": {
                "type": "integer"
              },
              "page_size": {
                "type": "integer"
              }
            },
            "additionalProperties": false
          }
        },
        "required": [
          "success",
          "data",
          "meta"
        ],
        "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

* [Fundable provider guide](/docs/providers/fundable/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)


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