> ## 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: Get Job

> Retrieve one LinkedIn job by job ID or URL. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Retrieve one LinkedIn job by job ID or URL.

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

## 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_get_job',
  {
    "jobId": "job_123",
    "url": "https://example.com/resource"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute harvestapi_get_job --input '{
  "jobId": "job_123",
  "url": "https://example.com/resource"
}' --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": {
    "element": {
      "id": "id_123"
    },
    "status": 1,
    "error": "example"
  }
}
```

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

## Input reference

Get the LinkedIn job details by job ID or URL.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.jobId` | `string` | No | — | ID of the LinkedIn job (optional) Minimum length: 1. |
| `payload.url` | `string` | No | — | URL of the LinkedIn job (optional) Format: `uri`. Minimum length: 1. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get the LinkedIn job details by job ID or URL.",
    "properties": {
      "jobId": {
        "type": "string",
        "description": "ID of the LinkedIn job (optional)",
        "minLength": 1
      },
      "url": {
        "type": "string",
        "description": "URL of the LinkedIn job (optional)",
        "minLength": 1,
        "format": "uri"
      }
    },
    "required": [],
    "allOf": [
      {
        "anyOf": [
          {
            "required": [
              "jobId"
            ]
          },
          {
            "required": [
              "url"
            ]
          }
        ]
      }
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.element` | `object` | No | — | — |
| `result.data.element.id` | `string` | Yes | — | — |
| `result.data.element.title` | `string` | No | — | — |
| `result.data.element.linkedinUrl` | `string` | No | — | — |
| `result.data.element.jobState` | `string` | No | — | — |
| `result.data.element.postedDate` | `string` | No | — | Format: `date-time`. |
| `result.data.element.descriptionText` | `string` | No | — | — |
| `result.data.element.descriptionHtml` | `string` | No | — | — |
| `result.data.element.location` | `object` | No | — | — |
| `result.data.element.location.linkedinText` | `string` | No | — | — |
| `result.data.element.location.postalAddress` | `string` | No | — | Format: `nullable`. |
| `result.data.element.location.parsed` | `object` | No | — | — |
| `result.data.element.location.parsed.text` | `string` | No | — | — |
| `result.data.element.location.parsed.countryCode` | `string` | No | — | — |
| `result.data.element.location.parsed.regionCode` | `string` | No | — | Format: `nullable`. |
| `result.data.element.location.parsed.country` | `string` | No | — | — |
| `result.data.element.location.parsed.countryFull` | `string` | No | — | — |
| `result.data.element.location.parsed.state` | `string` | No | — | — |
| `result.data.element.location.parsed.city` | `string` | No | — | — |
| `result.data.element.employmentType` | `string` | No | — | — |
| `result.data.element.workplaceType` | `string` | No | — | — |
| `result.data.element.workRemoteAllowed` | `boolean` | No | — | — |
| `result.data.element.easyApplyUrl` | `string` | No | — | — |
| `result.data.element.applicants` | `integer` | No | — | Format: `int32`. |
| `result.data.element.companyName` | `string` | No | — | — |
| `result.data.element.companyLogo` | `string` | No | — | — |
| `result.data.element.companyLink` | `string` | No | — | — |
| `result.data.element.companyUniversalName` | `string` | No | — | — |
| `result.data.element.salary` | `object` | No | — | — |
| `result.data.element.salary.min` | `string` | No | — | — |
| `result.data.element.salary.max` | `string` | No | — | — |
| `result.data.element.salary.currency` | `string` | No | — | — |
| `result.data.element.salary.text` | `string` | No | — | — |
| `result.data.element.views` | `integer` | No | — | Format: `int32`. |
| `result.data.element.expireAt` | `string` | No | — | Format: `date-time`. |
| `result.data.element.new` | `boolean` | No | — | — |
| `result.data.element.jobApplicationLimitReached` | `boolean` | No | — | — |
| `result.data.element.applicantTrackingSystem` | `string` | No | — | — |
| `result.data.status` | `string \| integer` | No | — | — |
| `result.data.error` | `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": {
          "element": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "title": {
                "type": "string"
              },
              "linkedinUrl": {
                "type": "string"
              },
              "jobState": {
                "type": "string"
              },
              "postedDate": {
                "type": "string",
                "format": "date-time"
              },
              "descriptionText": {
                "type": "string"
              },
              "descriptionHtml": {
                "type": "string"
              },
              "location": {
                "type": "object",
                "properties": {
                  "linkedinText": {
                    "type": "string"
                  },
                  "postalAddress": {
                    "type": "string",
                    "format": "nullable"
                  },
                  "parsed": {
                    "type": "object",
                    "properties": {
                      "text": {
                        "type": "string"
                      },
                      "countryCode": {
                        "type": "string"
                      },
                      "regionCode": {
                        "type": "string",
                        "format": "nullable"
                      },
                      "country": {
                        "type": "string"
                      },
                      "countryFull": {
                        "type": "string"
                      },
                      "state": {
                        "type": "string"
                      },
                      "city": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "additionalProperties": false
              },
              "employmentType": {
                "type": "string"
              },
              "workplaceType": {
                "type": "string"
              },
              "workRemoteAllowed": {
                "type": "boolean"
              },
              "easyApplyUrl": {
                "type": "string"
              },
              "applicants": {
                "type": "integer",
                "format": "int32"
              },
              "companyName": {
                "type": "string"
              },
              "companyLogo": {
                "type": "string"
              },
              "companyLink": {
                "type": "string"
              },
              "companyUniversalName": {
                "type": "string"
              },
              "salary": {
                "type": "object",
                "properties": {
                  "min": {
                    "type": "string"
                  },
                  "max": {
                    "type": "string"
                  },
                  "currency": {
                    "type": "string"
                  },
                  "text": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              },
              "views": {
                "type": "integer",
                "format": "int32"
              },
              "expireAt": {
                "type": "string",
                "format": "date-time"
              },
              "new": {
                "type": "boolean"
              },
              "jobApplicationLimitReached": {
                "type": "boolean"
              },
              "applicantTrackingSystem": {
                "type": "string"
              }
            },
            "required": [
              "id"
            ],
            "additionalProperties": false
          },
          "status": {
            "type": [
              "string",
              "integer"
            ]
          },
          "error": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "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.