List entities in dataset
curl --request POST \
--url https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"page": 1,
"page_size": 100,
"search": "OpenAI",
"status": "ready",
"entity_type": "company",
"sort_by": "created_at",
"sort_order": "desc"
}
'import requests
url = "https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list"
payload = {
"page": 1,
"page_size": 100,
"search": "OpenAI",
"status": "ready",
"entity_type": "company",
"sort_by": "created_at",
"sort_order": "desc"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
page: 1,
page_size: 100,
search: 'OpenAI',
status: 'ready',
entity_type: 'company',
sort_by: 'created_at',
sort_order: 'desc'
})
};
fetch('https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list', 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://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'page' => 1,
'page_size' => 100,
'search' => 'OpenAI',
'status' => 'ready',
'entity_type' => 'company',
'sort_by' => 'created_at',
'sort_order' => 'desc'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list"
payload := strings.NewReader("{\n \"page\": 1,\n \"page_size\": 100,\n \"search\": \"OpenAI\",\n \"status\": \"ready\",\n \"entity_type\": \"company\",\n \"sort_by\": \"created_at\",\n \"sort_order\": \"desc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"page\": 1,\n \"page_size\": 100,\n \"search\": \"OpenAI\",\n \"status\": \"ready\",\n \"entity_type\": \"company\",\n \"sort_by\": \"created_at\",\n \"sort_order\": \"desc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"page\": 1,\n \"page_size\": 100,\n \"search\": \"OpenAI\",\n \"status\": \"ready\",\n \"entity_type\": \"company\",\n \"sort_by\": \"created_at\",\n \"sort_order\": \"desc\"\n}"
response = http.request(request)
puts response.read_body{
"entities": [
{
"id": "854198fa-f702-49db-a381-0427fa87f173",
"name": "NewsCatcher",
"entity_type": "company",
"status": "pending",
"description": "NewsCatcher is a data-as-a-service company providing news intelligence APIs including the CatchAll Web Search API (2B+ web pages indexed) and News API (140,000+ sources, 100+ countries).",
"external_entity_id": "crm-12345",
"attributes": {
"domain": "newscatcherapi.com",
"key_persons": [
"Artem Bugara",
"Maksym Sugonyaka"
],
"alternative_names": [
"NewsCatcher CatchAll",
"NewsCatcher API"
]
}
}
],
"total": 4,
"page": 1,
"page_size": 100
}{
"detail": "X-API-Key header is required for this endpoint"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Datasets
List entities in dataset
Returns a paginated list of entities in a dataset. Supports filtering by status, entity type, and name search.
POST
/
catchAll
/
datasets
/
{dataset_id}
/
entities
/
list
List entities in dataset
curl --request POST \
--url https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"page": 1,
"page_size": 100,
"search": "OpenAI",
"status": "ready",
"entity_type": "company",
"sort_by": "created_at",
"sort_order": "desc"
}
'import requests
url = "https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list"
payload = {
"page": 1,
"page_size": 100,
"search": "OpenAI",
"status": "ready",
"entity_type": "company",
"sort_by": "created_at",
"sort_order": "desc"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
page: 1,
page_size: 100,
search: 'OpenAI',
status: 'ready',
entity_type: 'company',
sort_by: 'created_at',
sort_order: 'desc'
})
};
fetch('https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list', 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://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'page' => 1,
'page_size' => 100,
'search' => 'OpenAI',
'status' => 'ready',
'entity_type' => 'company',
'sort_by' => 'created_at',
'sort_order' => 'desc'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list"
payload := strings.NewReader("{\n \"page\": 1,\n \"page_size\": 100,\n \"search\": \"OpenAI\",\n \"status\": \"ready\",\n \"entity_type\": \"company\",\n \"sort_by\": \"created_at\",\n \"sort_order\": \"desc\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"page\": 1,\n \"page_size\": 100,\n \"search\": \"OpenAI\",\n \"status\": \"ready\",\n \"entity_type\": \"company\",\n \"sort_by\": \"created_at\",\n \"sort_order\": \"desc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"page\": 1,\n \"page_size\": 100,\n \"search\": \"OpenAI\",\n \"status\": \"ready\",\n \"entity_type\": \"company\",\n \"sort_by\": \"created_at\",\n \"sort_order\": \"desc\"\n}"
response = http.request(request)
puts response.read_body{
"entities": [
{
"id": "854198fa-f702-49db-a381-0427fa87f173",
"name": "NewsCatcher",
"entity_type": "company",
"status": "pending",
"description": "NewsCatcher is a data-as-a-service company providing news intelligence APIs including the CatchAll Web Search API (2B+ web pages indexed) and News API (140,000+ sources, 100+ countries).",
"external_entity_id": "crm-12345",
"attributes": {
"domain": "newscatcherapi.com",
"key_persons": [
"Artem Bugara",
"Maksym Sugonyaka"
],
"alternative_names": [
"NewsCatcher CatchAll",
"NewsCatcher API"
]
}
}
],
"total": 4,
"page": 1,
"page_size": 100
}{
"detail": "X-API-Key header is required for this endpoint"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
API key for authentication.
Path Parameters
Unique dataset identifier.
Body
application/json
The page number to retrieve.
Required range:
x >= 1Example:
1
The number of entities per page.
Required range:
1 <= x <= 500Example:
100
Filters entities by name using a case-insensitive substring match.
Example:
"OpenAI"
Processing status of an entity.
pending: Entity has been created and is queued for enrichment.enriching: Enrichment is in progress.ready: Enrichment complete — entity is indexed and ready for use in jobs.failed: Enrichment failed. The entity may still be used but matching quality may be reduced.
Available options:
pending, enriching, ready, failed The type of entity.
company: A company or organization (default).person: An individual person.
Available options:
company, person Fields available for sorting entity list results.
Available options:
created_at, name, status Sort direction for list results.
asc: ascending (oldest or smallest first)desc: descending (newest or largest first)
Available options:
asc, desc Response
Paginated list of entities in a dataset.
Was this page helpful?

