Skip to main content
GET
/
catchAll
/
datasets
/
{dataset_id}
/
entities
List entities in dataset
curl --request GET \
  --url https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}/entities \
  --header 'x-api-key: <api-key>'
{
  "entities": [
    {
      "id": "854198fa-f702-49db-a381-0427fa87f173",
      "name": "NewsCatcher",
      "entity_type": "company",
      "status": "pending",
      "description": "AI-powered news data provider",
      "attributes": {
        "domain": "newscatcherapi.com",
        "description": "Provider of news and web search APIs for developers",
        "key_persons": [
          "Artem Bugara",
          "Maksym Sugonyaka"
        ],
        "alternative_names": [
          "NC",
          "NewsCatcher API"
        ]
      }
    }
  ],
  "total": 4,
  "page": 1,
  "page_size": 100
}

Authorizations

​
x-api-key
string
header
required

API key for authentication.

Path Parameters

​
dataset_id
string<uuid>
required

Unique dataset identifier.

Query Parameters

​
page
integer
default:1

Page number to retrieve.

Required range: x >= 1
​
page_size
integer
default:100

Number of entities per page.

Required range: 1 <= x <= 500
​
search
string

Filter entities by name.

​
status
enum<string>

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
​
entity_type
enum<string>
default:company

The type of entity.

  • company: A company or organization (default).
  • person: An individual person.
Available options:
company,
person
​
sort_by
enum<string>
default:created_at

Fields available for sorting entity list results.

Available options:
created_at,
name,
status
​
sort_order
enum<string>
default:desc

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.

​
entities
object[]
required

Array of entity summary objects for this page.

​
total
integer
required

Total number of entities in the dataset.

Example:

4

​
page
integer
required

Current page number.

Example:

1

​
page_size
integer
required

Number of entities per page.

Example:

100