Gemini Application

https://www.norscout.com/docs
Admin
This project provides core application services and APIs, potentially interacting with a Gemini AI...
Tokens:7,013
Snippets:36
Trust Score:5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Start job response example

Source: https://www.norscout.com/docs

Example response when starting an enrichment job. It includes a jobId, status, statusUrl for polling, and details about the request.

```json
{
  "jobId": 91234,
  "status": "queued",
  "statusUrl": "/api/v1/enrichment/91234",
  "requestId": "req_123456789",
  "requestedOutput": ["email", "phone"],
  "receivedRows": 1,
  "credits": { "reserved": 2, "charged": 0 }
}
```

--------------------------------

### Location Examples

Source: https://www.norscout.com/docs

Provides examples of how to structure location objects for company searches.

```json
[
  { "type": "city", "name": "OSLO" },
  { "type": "municipality", "name": "ASKER" },
  { "country": "NO", "type": "county", "name": "03" },
  { "country": "NO", "type": "region", "name": "vestlandet" }
]
```

--------------------------------

### Start an enrichment job

Source: https://www.norscout.com/docs

Starts an enrichment job by sending person and company details. It returns a jobId and statusUrl immediately. Results can be retrieved via polling the statusUrl or through a webhook.

```APIDOC
## POST /api/v1/enrichment

### Description
Starts an enrichment job and returns a `jobId` and `statusUrl` immediately.

### Method
POST

### Endpoint
`/api/v1/enrichment`

### Parameters
#### Request Body
- **output** (string[]) - Required - Requested fields. Supported values: email, phone, or both.
- **rows** (object[]) - Required - People to enrich. The limit is 100 rows per minute.
  - **company_name** (string) - Required - Company name for the contact.
  - **country_code** (string) - Required - 2-letter ISO country code, for example NO or SE.
  - **person_name** (string) - Required - Full name of the person to enrich.
  - **role** (string) - Optional - Role or title. Improves matching quality.
  - **company_website** (string) - Optional - Company domain or URL. Improves matching quality.
  - **company_org_number** (string) - Optional - Optional organization number. Improves company matching quality.
- **webhook_url** (string) - Optional - Public HTTPS endpoint. Norscout posts the final result payload there when the job finishes. Omit it if you want to poll the status URL instead.
- **source** (string) - Optional - Optional caller-defined label. Returned in the start response when supplied.

### Request Example
```json
{
  "output": ["email", "phone"],
  "webhook_url": "https://example.com/api/webhooks/enrichment",
  "rows": [
    {
      "company_name": "Acme AS",
      "country_code": "NO",
      "person_name": "Kari Nordmann"
    }
  ]
}
```

### Response
#### Success Response (200)
- **jobId** (integer) - Unique identifier for the job.
- **status** (string) - Current status of the job (e.g., "queued").
- **statusUrl** (string) - URL to poll for job status updates.
- **requestId** (string) - Unique identifier for the request.
- **requestedOutput** (string[]) - The output fields that were requested.
- **receivedRows** (integer) - The number of rows received in the request.
- **credits** (object) - Information about reserved and charged credits.
  - **reserved** (integer) - Credits reserved for the job.
  - **charged** (integer) - Credits charged for the job.

#### Response Example
```json
{
  "jobId": 91234,
  "status": "queued",
  "statusUrl": "/api/v1/enrichment/91234",
  "requestId": "req_123456789",
  "requestedOutput": ["email", "phone"],
  "receivedRows": 1,
  "credits": { "reserved": 2, "charged": 0 }
}
```
```

--------------------------------

### Company Search Response Example

Source: https://www.norscout.com/docs

Illustrates a typical JSON response from the company search API, including company details and pagination metadata.

```json
{
  "companies": [
    {
      "id": 123,
      "org_number": "123456789",
      "name": "Acme AS",
      "ceo_name": "Kari Nordmann",
      "chairman_name": null,

```

--------------------------------

### Company Search Request Example

Source: https://www.norscout.com/docs

Demonstrates a POST request to search for companies with specific criteria, including country, industries, location, and revenue.

```curl
curl -X POST 'https://www.norscout.com/api/v1/companies/search' \
  -H "Authorization: Bearer $NORSCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "country": "NO", \
    "industries": ["62.010"], \
    "locations": [ \
      { \
        "country": "NO", \
        "type": "city", \
        "name": "OSLO" \
      } \
    ], \
    "min_revenue": 10000000, \
    "limit": 50, \
    "offset": 0 \
  }'
```

--------------------------------

### Check job status (completed)

Source: https://www.norscout.com/docs

Example response when a job has completed. It shows the 'completed' status and the enriched row data, including email, phone, and notes.

```json
{
  "status": "completed",
  "rows": [
    {
      "status": "completed",
      "email": "kari@acme.no",
      "phone": "+47 90 12 34 56",
      "notes": {
        "email": null,
        "phone": null
      }
    }
  ]
}
```

--------------------------------

### Start an enrichment job

Source: https://www.norscout.com/docs

Initiates an enrichment job by sending a POST request to the /api/v1/enrichment endpoint. Includes output fields, webhook URL, and row data. The response provides job details and a status URL.

```bash
curl -X POST 'https://www.norscout.com/api/v1/enrichment' \
  -H "Authorization: Bearer $NORSCOUT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ \
    "output": ["email", "phone"], \
    "webhook_url": "https://example.com/api/webhooks/enrichment", \
    "rows": [ \
      { \
        "company_name": "Acme AS", \
        "country_code": "NO", \
        "person_name": "Kari Nordmann" \
      } \
    ] \
  }'
```

--------------------------------

### GET Radar Feed

Source: https://www.norscout.com/docs

Retrieves a feed of radar events for companies that are being monitored.

```APIDOC
## GET /radar/feed

### Description
Fetches a feed of recent radar events for monitored companies.

### Method
GET

### Endpoint
/radar/feed

### Query Parameters
- **since** (string) - Optional - Timestamp to filter events occurring after this time (ISO 8601 format).
- **limit** (integer) - Optional - The maximum number of events to return.

### Response
#### Success Response (200)
- **events** (array) - A list of radar event objects.
  - **event** (object) - Details of a radar event.
    - **company_name** (string) - The name of the company associated with the event.
    - **type** (string) - The type of radar event.
    - **timestamp** (string) - The time the event occurred.

#### Response Example
{
  "events": [
    {
      "company_name": "Example Corp",
      "type": "new_funding",
      "timestamp": "2023-10-27T10:00:00Z"
    }
  ]
}
```

--------------------------------

### GET Radar Subscriptions

Source: https://www.norscout.com/docs

Retrieves a list of companies for which radar events are currently being monitored.

```APIDOC
## GET /radar/subscriptions

### Description
Lists all companies currently being monitored for radar events.

### Method
GET

### Endpoint
/radar/subscriptions

### Response
#### Success Response (200)
- **subscriptions** (array) - A list of company objects being monitored.
  - **company** (object) - Details of a monitored company.
    - **name** (string) - The name of the company.
    - **domain** (string) - The primary domain of the company.

#### Response Example
{
  "subscriptions": [
    {
      "name": "Example Corp",
      "domain": "example.com"
    }
  ]
}
```

--------------------------------

### Check job status (active)

Source: https://www.norscout.com/docs

Example response when polling for a job status that is still active. It indicates the current status and an empty rows array.

```json
{
  "status": "active",
  "rows": []
}
```

--------------------------------

### GET Check Job

Source: https://www.norscout.com/docs

Checks the status and results of an ongoing or completed enrichment job.

```APIDOC
## GET /enrich/job/{job_id}

### Description
Retrieves the status and results of a specific enrichment job.

### Method
GET

### Endpoint
/enrich/job/{job_id}

### Parameters
#### Path Parameters
- **job_id** (string) - Required - The ID of the enrichment job to check.

### Response
#### Success Response (200)
- **status** (string) - The current status of the job (e.g., 'processing', 'completed', 'failed').
- **results** (object) - The enrichment results, if the job is completed.
  - **email** (array) - A list of found email addresses.
  - **phone** (array) - A list of found phone numbers.

#### Response Example
{
  "status": "completed",
  "results": {
    "email": ["info@example.com"],
    "phone": ["+1234567890"]
  }
}
```

--------------------------------

### GET /api/v1/radar/subscriptions

Source: https://www.norscout.com/docs

Retrieves a list of active radar subscriptions and the count of companies currently being tracked. This endpoint is useful for monitoring ongoing alerts and the scope of company monitoring.

```APIDOC
## GET /api/v1/radar/subscriptions

### Description
Returns active radar subscriptions and `tracked_companies` (companies with active monitoring).

### Method
GET

### Endpoint
`/api/v1/radar/subscriptions`

### Request Example
```
curl 'https://www.norscout.com/api/v1/radar/subscriptions' \
  -H "Authorization: Bearer $NORSCOUT_API_KEY"
```

### Response
#### Success Response (200)
- **subscriptions** (object[]) - List of active radar subscriptions.
  - **id** (integer) - Subscription identifier.
  - **company** (object) - Information about the company being monitored.
    - **name** (string) - Company name.
    - **org_number** (string) - Company organization number.
  - **signal_type** (string) - The type of signal being monitored.
  - **status** (string) - The current status of the subscription.
  - **tracking_status** (string) - The status of company tracking.
  - **last_event_at** (string) - Timestamp of the last event detected for this subscription.
  - **created_at** (string) - Timestamp when the subscription was created.
- **tracked_companies** (integer) - The total number of companies with active monitoring.
- **request_id** (string) - Request identifier.

### Response Example
```json
{
  "subscriptions": [
    {
      "id": 1,
      "company": {
        "name": "Acme AS",
        "org_number": "123456789"
      },
      "signal_type": "job_openings",
      "status": "active",
      "tracking_status": "active",
      "last_event_at": "2026-06-07T10:00:00.000Z",
      "created_at": "2026-05-01T08:00:00.000Z"
    }
  ],
  "tracked_companies": 1,
  "request_id": "req_123456789"
}
```
```

--------------------------------

### Check job status and results

Source: https://www.norscout.com/docs

Retrieves the current status of an enrichment job and, once completed, the row-level results. This endpoint is polled using the statusUrl obtained from starting a job.

```APIDOC
## GET /api/v1/enrichment/{jobId}

### Description
Returns the current job status and final row-level results.

### Method
GET

### Endpoint
`/api/v1/enrichment/{jobId}`

### Parameters
#### Path Parameters
- **jobId** (string) - Required - The ID of the job to check.

### Response
#### Success Response (200)
- **status** (string) - Current job state. Possible values: `active`, `completed`, `failed`, `cancelled`.
- **rows** (object[]) - Final row-level results in the same order as the rows submitted. Empty while the job is active.
  - **status** (string) - Per-row result state. Possible values: `completed`, `not_found`, `failed`, `partial`.
  - **email** (string | null) - Resolved email value if email was requested.
  - **phone** (string | null) - Resolved phone value if phone was requested.
  - **notes** (object) - Per-output explanation keyed by email and phone when a value is missing, partial, or failed.

#### Response Example (Active Job)
```json
{
  "status": "active",
  "rows": []
}
```

#### Response Example (Completed Job)
```json
{
  "status": "completed",
  "rows": [
    {
      "status": "completed",
      "email": "kari@acme.no",
      "phone": "+47 90 12 34 56",
      "notes": {
        "email": null,
        "phone": null
      }
    }
  ]
}
```
```

--------------------------------

### GET /api/v1/radar/feed

Source: https://www.norscout.com/docs

Retrieves unlocked radar events. It allows filtering by various parameters and provides pagination details. Use `locked_count` to identify events that require unlocking within NorScout to be included.

```APIDOC
## GET /api/v1/radar/feed

### Description
Returns unlocked radar events. Use `locked_count` to see how many locked events match the same filters.

### Method
GET

### Endpoint
`/api/v1/radar/feed`

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Page size. Defaults to 50. Maximum 100.
- **cursor** (string) - Optional - Opaque cursor from pagination. `next_cursor` in the previous response.
- **signal_type** (string) - Optional - Filter by one radar signal type.
- **org_number** (string) - Optional - Filter by company organization number.
- **since** (string) - Optional - Only return events with `detected_at` greater than or equal to this ISO 8601 datetime.

### Response
#### Success Response (200)
- **events** (object[]) - Unlocked radar events. Locked events are not included.
- **locked_count** (integer) - Number of locked events matching the same filters. Counts raw rows; events may deduplicate `address_changes`.
- **pagination** (object) - Cursor pagination metadata for the feed.
  - **next_cursor** (string | null) - Pass this value as cursor on the next request to fetch older events.
  - **has_more** (boolean) - True when more unlocked events are available.
  - **limit** (integer) - The page size used for this response.
- **request_id** (string) - Request identifier.

### Request Example
```
curl 'https://www.norscout.com/api/v1/radar/feed?limit=50' \
  -H "Authorization: Bearer $NORSCOUT_API_KEY"
```

### Response Example
```json
{
  "events": [
    {
      "id": 2011,
      "company": {
        "name": "Acme AS",
        "org_number": "123456789"
      },
      "signal_type": "news_pr",
      "title": "Office move to Nedre Vollgate 5",
      "summary": "Acme AS moved its office to Nedre Vollgate 5.",
      "detected_at": "2026-06-07T10:00:00.000Z",
      "event_date": "2026-06-07",
      "sources": [
        {
          "url": "https://example.com/article",
          "title": "Example article",
          "published_at": "2026-06-07T09:30:00.000Z"
        }
      ]
    }
  ],
  "locked_count": 0,
  "pagination": {
    "next_cursor": null,
    "has_more": false,
    "limit": 50
  },
  "request_id": "req_123456789"
}
```

### Polling
- Poll every 1-5 minutes.
- Pass `since` for incremental sync.
- Pass `cursor` from `pagination.next_cursor` for older pages.
- If `locked_count` is greater than 0, unlock those events in NorScout to include them in `events`.
```

--------------------------------

### Fetch Radar Subscriptions

Source: https://www.norscout.com/docs

Retrieve active radar subscriptions and the count of companies being tracked. Requires an API key for authentication.

```bash
curl 'https://www.norscout.com/api/v1/radar/subscriptions' \
  -H "Authorization: Bearer $NORSCOUT_API_KEY"
```

--------------------------------

### POST Enrich

Source: https://www.norscout.com/docs

Initiates an enrichment job for a given company or domain. This job will gather additional information.

```APIDOC
## POST /enrich

### Description
Starts an enrichment job for a specified company or domain.

### Method
POST

### Endpoint
/enrich

### Request Body
- **domain** (string) - Required - The domain to enrich.

### Request Example
{
  "domain": "example.com"
}

### Response
#### Success Response (200)
- **job_id** (string) - The unique identifier for the enrichment job.

#### Response Example
{
  "job_id": "enrich-job-12345"
}
```

--------------------------------

### Fetch Radar Feed

Source: https://www.norscout.com/docs

Use this endpoint to retrieve unlocked radar events. Pass query parameters to filter results. Poll every 1-5 minutes for updates.

```bash
curl 'https://www.norscout.com/api/v1/radar/feed?limit=50' \
  -H "Authorization: Bearer $NORSCOUT_API_KEY"
```

--------------------------------

### Radar Subscriptions Response Structure

Source: https://www.norscout.com/docs

The response contains a list of active subscriptions, each detailing company information, signal type, and tracking status. It also includes the total count of tracked companies.

```json
{
  "subscriptions": [
    {
      "id": 1,
      "company": {
        "name": "Acme AS",
        "org_number": "123456789"
      },
      "signal_type": "job_openings",
      "status": "active",
      "tracking_status": "active",
      "last_event_at": "2026-06-07T10:00:00.000Z",
      "created_at": "2026-05-01T08:00:00.000Z"
    }
  ],
  "tracked_companies": 1,
  "request_id": "req_123456789"
}
```

--------------------------------

### Radar Feed Response Structure

Source: https://www.norscout.com/docs

The response includes a list of unlocked radar events, a count of locked events, and pagination metadata. Locked events can be unlocked in NorScout to be included.

```json
{
  "events": [
    {
      "id": 2011,
      "company": {
        "name": "Acme AS",
        "org_number": "123456789"
      },
      "signal_type": "news_pr",
      "title": "Office move to Nedre Vollgate 5",
      "summary": "Acme AS moved its office to Nedre Vollgate 5.",
      "detected_at": "2026-06-07T10:00:00.000Z",
      "event_date": "2026-06-07",
      "sources": [
        {
          "url": "https://example.com/article",
          "title": "Example article",
          "published_at": "2026-06-07T09:30:00.000Z"
        }
      ]
    }
  ],
  "locked_count": 0,
  "pagination": {
    "next_cursor": null,
    "has_more": false,
    "limit": 50
  },
  "request_id": "req_123456789"
}
```

--------------------------------

### Company Search

Source: https://www.norscout.com/docs

Searches companies with the same public filter surface as NorScout search. The API uses a `search:read` API key scope.

```APIDOC
## POST /api/v1/companies/search

### Description
Searches companies based on provided filters. Requires `search:read` API key scope.

### Method
POST

### Endpoint
/api/v1/companies/search

### Parameters
#### Query Parameters
- **country** (string) - Optional - Company country. Defaults to NO when omitted.
- **query** (string) - Optional - Company name or organization number. Maximum 200 characters.
- **sort_by** (string) - Optional - Sort field. Allowed values: `name`, `number_of_employees`, `revenue`.
- **sort_direction** (string) - Optional - Sort direction. Allowed values: `asc`, `desc`.
- **limit** (integer) - Optional - Page size. Defaults to 10. Maximum 100.
- **offset** (integer) - Optional - Zero-based result offset. Use 0 or a positive integer.

#### Request Body
- **country** (string) - Optional - Location country. Defaults to NO if omitted and must match the top-level country.
- **type** (string) - Required - Location kind. Use `region` only with country NO.
- **name** (string) - Required - Location value. Use a city or municipality name, a county code such as 03, or one of the Norwegian region keys: `sornorge`, `vestlandet`, `nordnorge`.
- **industries** (string[]) - Optional - NACE industry codes, for example `62.010`.
- **locations** (object[]) - Optional - Locations in the same shape used by NorScout search.
  - **country** (string) - Optional - Optional location country. Defaults to NO if omitted and must match the top-level country.
  - **type** (string) - Required - Location kind. Use `region` only with country NO.
  - **name** (string) - Required - Location value. Use a city or municipality name, a county code such as 03, or one of the Norwegian region keys: `sornorge`, `vestlandet`, `nordnorge`.
- **min_revenue** (number) - Optional - Minimum revenue in full local-currency values. Use 0 or a positive number. Use 10000000 for 10 million.
- **max_revenue** (number) - Optional - Maximum revenue in full local-currency values. Use 0 or a positive number. Must be greater than or equal to `min_revenue`.
- **min_employees** (integer) - Optional - Minimum employee count. Use 0 or a positive integer.
- **max_employees** (integer) - Optional - Maximum employee count. Use 0 or a positive integer.
- **exclude_holding** (boolean) - Optional - Exclude holding companies.
- **exclude_enk** (boolean) - Optional - Exclude Norwegian sole proprietorships. Ignored for Sweden.

### Request Example
```json
{
  "country": "NO",
  "industries": ["62.010"],
  "locations": [
    { "country": "NO", "type": "city", "name": "OSLO" }
  ],
  "min_revenue": 10000000,
  "limit": 50,
  "offset": 0
}
```

### Response
#### Success Response (200)
- **companies** (object[]) - Company rows returned for this page.
  - **id** (integer) - NorScout company ID.
  - **org_number** (string) - Company organization number.
  - **name** (string) - Company legal name.
  - **ceo_name** (string | null) - CEO or general manager name when available.
  - **chairman_name** (string | null) - Chairman name when available.
  - **contact_person_name** (string | null) - Contact person name when available.
  - **industry** (string | null) - Primary industry name.
  - **business_city** (string | null) - Registered business city.
  - **business_municipality** (string | null) - Registered business municipality.
  - **business_address** (string | null) - Registered business address.
  - **business_country_code** (string | null) - Registered business country code.
  - **number_of_employees** (integer | null) - Registered employee count.
  - **revenue** (number | null) - Latest available revenue.
  - **period_from** (string | null) - Start date for the financial period behind revenue.
  - **period_to** (string | null) - End date for the financial period behind revenue.
  - **website** (string | null) - Company website.
  - **email** (string | null) - Company email address.
  - **phone** (string | null) - Company phone number.
  - **registered_in_registry_date** (string | null) - Date when the company was registered.
- **pagination** (object) - Page metadata.
  - **limit** (integer) - Page size used for this response.
  - **offset** (integer) - Offset used for this response.
  - **has_more** (boolean) - True only when more rows are available inside the allowed window.
  - **total** (integer) - Number of matching companies available within the current plan and quota window.
  - **total_matching** (integer) - Raw number of companies matching the filters before plan and quota caps.
- **usage** (object) - Shared monthly company data allowance across CSV exports and API search.
  - **limit** (integer) - Monthly company data allowance for the account.
  - **exports_used** (integer) - Rows already used by CSV exports in this billing period.
  - **company_search_rows_used** (integer) - Rows already returned by API company search in this billing period.
  - **remaining** (integer) - Rows remaining after this request.
- **request_id** (string) - Request identifier.

### Error Handling
- **402** - `external_api_export_limit_exceeded` when the monthly allowance is exhausted.

### Required Filters
Add at least one of `query`, `industries`, `locations`, revenue range, or employee range. Exclusion-only searches are rejected.
```

--------------------------------

### POST Company Search

Source: https://www.norscout.com/docs

Search for companies based on specified criteria. This endpoint allows you to find companies within the NorScout database.

```APIDOC
## POST /companies/search

### Description
Searches for companies based on provided criteria.

### Method
POST

### Endpoint
/companies/search

### Request Body
- **query** (string) - Required - The search query string.
- **limit** (integer) - Optional - The maximum number of results to return.

### Request Example
{
  "query": "example company name",
  "limit": 10
}

### Response
#### Success Response (200)
- **companies** (array) - A list of company objects matching the search criteria.
  - **company** (object) - Details of a company.
    - **name** (string) - The name of the company.
    - **domain** (string) - The primary domain of the company.

#### Response Example
{
  "companies": [
    {
      "name": "Example Corp",
      "domain": "example.com"
    }
  ]
}
```
Tokens:
Raw