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

# HarvestAPI: Search Geo Ids

> Resolve LinkedIn geographic IDs from location text. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Resolve LinkedIn geographic IDs from location text.

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

## 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(
  'harvestapi_search_geo_ids',
  {
    "search": "software companies hiring engineers"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute harvestapi_search_geo_ids --input '{
  "search": "software companies hiring engineers"
}' --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": "id_123",
    "status": 1,
    "error": "example"
  }
}
```

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

## Input reference

Search LinkedIn Geo ID by location text

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.search` | `string` | No | — | Location text to search for Geo ID (required) Minimum length: 1. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Search LinkedIn Geo ID by location text",
    "properties": {
      "search": {
        "type": "string",
        "description": "Location text to search for Geo ID (required)",
        "minLength": 1
      }
    },
    "required": [],
    "allOf": [
      {
        "anyOf": [
          {
            "required": [
              "search"
            ]
          }
        ]
      }
    ],
    "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` | No | — | — |
| `result.data.status` | `string \| integer` | No | — | — |
| `result.data.error` | `string \| null` | No | — | — |
| `result.data.elements` | `array` | No | — | — |
| `result.data.elements[].geoId` | `string` | No | — | — |
| `result.data.elements[].title` | `string` | No | — | — |
| `result.data.pagination` | `object \| null` | No | — | — |
| `result.data.pagination.totalPages` | `integer \| null` | No | — | — |
| `result.data.pagination.totalElements` | `integer \| null` | No | — | — |
| `result.data.pagination.pageNumber` | `integer \| null` | No | — | — |
| `result.data.pagination.previousElements` | `integer \| null` | No | — | — |
| `result.data.pagination.pageSize` | `integer \| null` | No | — | — |
| `result.data.pagination.paginationToken` | `string \| null` | No | — | — |
| `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"
          },
          "status": {
            "type": [
              "string",
              "integer"
            ]
          },
          "error": {
            "type": [
              "string",
              "null"
            ]
          },
          "elements": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "geoId": {
                  "type": "string"
                },
                "title": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          },
          "pagination": {
            "type": [
              "object",
              "null"
            ],
            "properties": {
              "totalPages": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "totalElements": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "pageNumber": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "previousElements": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "pageSize": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "paginationToken": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.01` per pricing unit.

## Related documentation

* [HarvestAPI provider guide](https://deepline.com/docs/providers/harvestapi/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.