---
title: "Get a search"
method: GET
path: "/v1/searches/{id}"
tags: ["Searches"]
---

# Get a search

`GET /v1/searches/{id}`

## Request

- Base URL: `https://api.nvoke.run`
- URL: `https://api.nvoke.run/v1/searches/{id}`
- Auth: HTTP bearer

One search with its status and counters: companies found and crawled, emails found and emails verified valid. `error` says why a search failed, for example `quota_exceeded`.

## Path parameters

- `id` string, uuid, required

## Response `200`

OK

- union
  - object
    - `id` string, uuid, required
    - `limit` integer, required
    - `status` 'queued' | 'running' | 'done' | 'failed' | 'canceled', required
    - `error` string, nullable, required
    - `companiesFound` integer, required
    - `companiesCrawled` integer, required
    - `emailsFound` integer, required
    - `emailsValid` integer, required
    - `createdAt` string, date-time, required
    - `startedAt` string, date-time, nullable, required
    - `finishedAt` string, date-time, nullable, required
    - `stage` string, nullable
    - `stageNote` string, nullable
    - `ongoing` boolean, nullable
    - `checkInboxes` boolean, nullable
    - `inboxesSkipped` integer, nullable
    - `inboxesPending` integer, nullable
    - `kind` 'local', required
    - `params` object, required
      - `niche` string, required
      - `location` string, required
    - `runs` object[]
      - `params` object, required
        - `niche` string, required
        - `location` string, required
      - `limit` integer, required
      - `foundBefore` integer, required
      - `createdAt` string, date-time, required
      - `trigger` 'escalate' | 'ongoing'
  - object
    - `id` string, uuid, required
    - `limit` integer, required
    - `status` 'queued' | 'running' | 'done' | 'failed' | 'canceled', required
    - `error` string, nullable, required
    - `companiesFound` integer, required
    - `companiesCrawled` integer, required
    - `emailsFound` integer, required
    - `emailsValid` integer, required
    - `createdAt` string, date-time, required
    - `startedAt` string, date-time, nullable, required
    - `finishedAt` string, date-time, nullable, required
    - `stage` string, nullable
    - `stageNote` string, nullable
    - `ongoing` boolean, nullable
    - `checkInboxes` boolean, nullable
    - `inboxesSkipped` integer, nullable
    - `inboxesPending` integer, nullable
    - `kind` 'web', required
    - `params` object, required
      - `keyword` string, required
      - `country` unknown
    - `runs` object[]
      - `params` object, required
        - `keyword` string, required
        - `country` unknown
      - `limit` integer, required
      - `foundBefore` integer, required
      - `createdAt` string, date-time, required
      - `trigger` 'escalate' | 'ongoing'
  - object
    - `id` string, uuid, required
    - `limit` integer, required
    - `status` 'queued' | 'running' | 'done' | 'failed' | 'canceled', required
    - `error` string, nullable, required
    - `companiesFound` integer, required
    - `companiesCrawled` integer, required
    - `emailsFound` integer, required
    - `emailsValid` integer, required
    - `createdAt` string, date-time, required
    - `startedAt` string, date-time, nullable, required
    - `finishedAt` string, date-time, nullable, required
    - `stage` string, nullable
    - `stageNote` string, nullable
    - `ongoing` boolean, nullable
    - `checkInboxes` boolean, nullable
    - `inboxesSkipped` integer, nullable
    - `inboxesPending` integer, nullable
    - `kind` 'launches', required
    - `params` object, required
      - `keyword` string
      - `days` integer, required
      - `sources` string[]
    - `runs` object[]
      - `params` object, required
        - `keyword` string
        - `days` integer, required
        - `sources` string[]
      - `limit` integer, required
      - `foundBefore` integer, required
      - `createdAt` string, date-time, required
      - `trigger` 'escalate' | 'ongoing'
  - object
    - `id` string, uuid, required
    - `limit` integer, required
    - `status` 'queued' | 'running' | 'done' | 'failed' | 'canceled', required
    - `error` string, nullable, required
    - `companiesFound` integer, required
    - `companiesCrawled` integer, required
    - `emailsFound` integer, required
    - `emailsValid` integer, required
    - `createdAt` string, date-time, required
    - `startedAt` string, date-time, nullable, required
    - `finishedAt` string, date-time, nullable, required
    - `stage` string, nullable
    - `stageNote` string, nullable
    - `ongoing` boolean, nullable
    - `checkInboxes` boolean, nullable
    - `inboxesSkipped` integer, nullable
    - `inboxesPending` integer, nullable
    - `kind` 'domains', required
    - `params` object, required
      - `items` unknown, required
      - `country` unknown
    - `runs` object[]
      - `params` object, required
        - `items` unknown, required
        - `country` unknown
      - `limit` integer, required
      - `foundBefore` integer, required
      - `createdAt` string, date-time, required
      - `trigger` 'escalate' | 'ongoing'
  - object
    - `id` string, uuid, required
    - `limit` integer, required
    - `status` 'queued' | 'running' | 'done' | 'failed' | 'canceled', required
    - `error` string, nullable, required
    - `companiesFound` integer, required
    - `companiesCrawled` integer, required
    - `emailsFound` integer, required
    - `emailsValid` integer, required
    - `createdAt` string, date-time, required
    - `startedAt` string, date-time, nullable, required
    - `finishedAt` string, date-time, nullable, required
    - `stage` string, nullable
    - `stageNote` string, nullable
    - `ongoing` boolean, nullable
    - `checkInboxes` boolean, nullable
    - `inboxesSkipped` integer, nullable
    - `inboxesPending` integer, nullable
    - `kind` 'drop', required
    - `params` object, required
      - `dropId` string, uuid, required
      - `dropName` string, required
      - `keyword` string
      - `sources` string[], required
  - object
    - `id` string, uuid, required
    - `limit` integer, required
    - `status` 'queued' | 'running' | 'done' | 'failed' | 'canceled', required
    - `error` string, nullable, required
    - `companiesFound` integer, required
    - `companiesCrawled` integer, required
    - `emailsFound` integer, required
    - `emailsValid` integer, required
    - `createdAt` string, date-time, required
    - `startedAt` string, date-time, nullable, required
    - `finishedAt` string, date-time, nullable, required
    - `stage` string, nullable
    - `stageNote` string, nullable
    - `ongoing` boolean, nullable
    - `checkInboxes` boolean, nullable
    - `inboxesSkipped` integer, nullable
    - `inboxesPending` integer, nullable
    - `kind` 'icp', required
    - `params` object, required
      - `description` string, required
      - `product` string
      - `countries` unknown[]
        - unknown
      - `locations` string[]
    - `runs` object[]
      - `params` object, required
        - `description` string, required
        - `product` string
        - `countries` unknown[]
          - unknown
        - `locations` string[]
      - `limit` integer, required
      - `foundBefore` integer, required
      - `createdAt` string, date-time, required
      - `trigger` 'escalate' | 'ongoing'

## Other responses

- `4XX`: `unauthorized`: No valid token. Send `Authorization: Bearer <key>`. `not_found`: No such search, key or webhook on this account.

---

[API](https://skmtc.dev/nvoke/apis/nvoke-api.md) · [All operations](https://skmtc.dev/nvoke/apis/nvoke-api/llms.txt) · [OpenAPI document](https://skmtc.dev/nvoke/apis/nvoke-api/revisions/6d78de7201f3?raw)