Instahyre Jobs API Capability

Get an Instahyre company

Retrieve a public employer profile and optionally its visible jobs.

Capability ID instahyre.company.get

Cost From $1.25 per 1,000 requests · 1 credit

Maximum runtime 60 seconds

# Get an Instahyre company

Retrieve a public employer profile and optionally its visible jobs.

- Platform: [Instahyre Jobs](https://docs.upscrape.com/docs/platforms/instahyre)
- Capability ID: `instahyre.company.get`
- Cost: 1 credit per request
- Maximum runtime: 60 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "id": 1535,
    "limit": 10,
    "visible_jobs": true
  },
  "capability": "instahyre.company.get"
}'
```

## Input


| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `integer` | Yes | At least 1. |
| `limit` | `integer` | No | Maximum visible jobs requested, up to 100. Zero or omitted uses the upstream default of 10, not all jobs. Compare jobs_count with returned jobs to check completeness. From 0 to 100. |
| `visible_jobs` | `boolean` | No | Include visible job records. False or omitted excludes the jobs field from the response. |

### Example input

```json
{
  "id": 1535,
  "limit": 10,
  "visible_jobs": true
}
```

## Response

Successful output is returned in `results[0].data`.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

No example output is available for this capability.


## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

id integer required

At least 1.

Example 1535

limit integer optional

Maximum visible jobs requested, up to 100. Zero or omitted uses the upstream default of 10, not all jobs. Compare jobs_count with returned jobs to check completeness. From 0 to 100.

Example 10

visible_jobs boolean optional

Include visible job records. False or omitted excludes the jobs field from the response.

Example true

Response

Successful output is returned in results[0].data.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

No example output is available for this capability yet.

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "id": 1535, "limit": 10, "visible_jobs": true }, "capability": "instahyre.company.get" }'

import json import os import requests payload = json.loads(r'''{ "input": { "id": 1535, "limit": 10, "visible_jobs": true }, "capability": "instahyre.company.get" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))