List Discovery Tasks

GET

discovery_tasks

curl --request GET \
  --url https://api.extruct.ai/v1/discovery_tasks \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.extruct.ai/v1/discovery_tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extruct.ai/v1/discovery_tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extruct.ai/v1/discovery_tasks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extruct.ai/v1/discovery_tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "query": "<string>",
    "desired_num_results": 123,
    "is_exhausted": false,
    "num_results_discovered": 0,
    "num_results_enriched": 0,
    "num_results_evaluated": 0,
    "num_results": 0,
    "table_id": "<string>",
    "auto_data_sources": true,
    "data_sources": [],
    "criteria": [
      {
        "key": "<string>",
        "name": "<string>",
        "criterion": "<string>"
      }
    ],
    "exclude_domains": [
      "<string>"
    ]
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Overview

This endpoint returns paginated Deep Search tasks with their current statuses.

Example request

export EXTRUCT_API_TOKEN="YOUR_API_TOKEN"

curl --get "https://api.extruct.ai/v1/discovery_tasks" \
  -H "Authorization: Bearer ${EXTRUCT_API_TOKEN}" \
  --data-urlencode "offset=0" \
  --data-urlencode "limit=20"

Key parameters

offset (optional): Pagination offset.
limit (optional): Page size.

Success signal

A successful response returns a paginated list of tasks with id, status, and progress counters.

Common errors

`401 Unauthorized`

Check that your header is Authorization: Bearer ${EXTRUCT_API_TOKEN}.

Deep Search

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset

integer | null

limit

integer | null

Response

Successful Response

string

required

created_at

string<date-time>

required

status

enum<string>

required

Available options:

created,

in_progress,

done,

failed

query

string

required

desired_num_results

integer

required

is_exhausted

boolean

default:false

num_results_discovered

integer

default:0

Total number of company candidates discovered from search

num_results_enriched

integer

default:0

Number of candidates enriched with company profiles

num_results_evaluated

integer

default:0

Number of candidates that had criteria evaluation completed

num_results

integer

default:0

Total number of results

table_id

string | null

auto_data_sources

boolean

default:true

data_sources

enum<string>[] | null

Available options:

web_search,

linkedin,

maps

criteria

CriterionDefinition · object[] | null

Show child attributes

exclude_domains

string[] | null

The resolved, sorted list of registered domains that were excluded from this run (union of exclude_domains and the visible results of exclude_task_ids at creation time). Capped at 1000.

List Discovery Tasks

curl --request GET \
  --url https://api.extruct.ai/v1/discovery_tasks \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.extruct.ai/v1/discovery_tasks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.extruct.ai/v1/discovery_tasks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.extruct.ai/v1/discovery_tasks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.extruct.ai/v1/discovery_tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "query": "<string>",
    "desired_num_results": 123,
    "is_exhausted": false,
    "num_results_discovered": 0,
    "num_results_enriched": 0,
    "num_results_evaluated": 0,
    "num_results": 0,
    "table_id": "<string>",
    "auto_data_sources": true,
    "data_sources": [],
    "criteria": [
      {
        "key": "<string>",
        "name": "<string>",
        "criterion": "<string>"
      }
    ],
    "exclude_domains": [
      "<string>"
    ]
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

API Reference

Company Search

Deep Search

Deep Research

Table Management

Table Execution

Other

List Discovery Tasks

Overview

Example request

Key parameters

Success signal

Common errors

`401 Unauthorized`

Authorizations

Query Parameters

Response

​Overview

​Example request

​Key parameters

​Success signal

​Common errors

​401 Unauthorized

​Related endpoints

​Related guides

Authorizations

Query Parameters

Response

Overview

Example request

Key parameters

Success signal

Common errors

`401 Unauthorized`

Related endpoints

Related guides