> ## Documentation Index
> Fetch the complete documentation index at: https://newscatcherinc-docs.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List datasets

> Returns a paginated list of datasets belonging to the authenticated organization. Supports filtering by status and sorting by name, status, or creation date.




## OpenAPI

````yaml catch-all-api get /catchAll/datasets
openapi: 3.1.0
info:
  title: NewsCatcher CatchAll API
  version: 1.6.4
  description: >
    CatchAll is a web search API that generates unique datasets that don't exist
    anywhere else on the web. Built on NewsCatcher's proprietary real-world
    event index, it delivers state-of-the-art recall—finding all relevant
    events, not just top results.


    ### Authentication


    All endpoints except /health and /version require `x-api-key` header. If the
    key is invalid or missing, the API returns the `403 Forbidden` error.


    ### Job workflow


    1. (Optional) Get suggestions via /catchAll/initialize

    2. Submit a query via /catchAll/submit with optional date ranges and custom
    validators/enrichments

    3. Poll /catchAll/status/{job_id} until completed (10-15 minutes)

    4. Retrieve results via /catchAll/pull/{job_id}


    ### Monitor workflow


    1. Create successful job via /catchAll/submit

    2. Create monitor via /catchAll/monitors/create with schedule

    3. Retrieve aggregated results via /catchAll/monitors/pull/{monitor_id}


    ### Webhook workflow


    1. Create a webhook via `POST /catchAll/webhooks`

    2. Attach it to a job or monitor via `POST
    /catchAll/webhooks/{webhook_id}/resources`,
       or pass `webhook_ids` at job or monitor creation time
    3. Receive HTTP notifications at the configured URL when each job completes


    ### Company search workflow


    1. Create a dataset via `POST /catchAll/datasets/` or `POST
    /catchAll/datasets/upload`

    2. Wait for the dataset `latest_status` to reach `ready`

    3. Submit a job with `connected_dataset_ids` pointing to your dataset

    4. Retrieve results — each record includes a `connected_entities` array
       with relevance scores per matched company

    ### Important notes


    **Dynamic schemas**: Response schemas are generated dynamically by LLMs.
    Field names in the `enrichment` object may vary and are not deterministic
    across jobs unless explicitly specified.
  contact:
    name: NewsCatcher
    url: https://newscatcherapi.com
    email: support@newscatcherapi.com
servers:
  - url: https://catchall.newscatcherapi.com
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Jobs
    description: Operations to create, monitor, and retrieve job results.
    externalDocs:
      description: Learn about job lifecycle and status tracking
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/get-started/quickstart
  - name: Monitors
    description: Operations to create, operate and retrieve monitor results.
    externalDocs:
      description: >-
        Automate recurring queries with scheduled jobs and webhook
        notifications.
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/monitors
  - name: Webhooks
    description: >
      Operations to create and manage reusable webhook endpoints.


      A webhook is a named HTTP endpoint that receives a POST notification

      when a job or monitor completes. Create webhooks once at the organization

      level and attach them to any number of jobs or monitors via `webhook_ids`.

      Supports Slack, Microsoft Teams, and generic HTTP targets with
      configurable

      delivery modes, authentication, and headers.
    externalDocs:
      description: Learn about centralized webhooks and notification setup
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/webhooks
  - name: Entities
    description: >
      Operations to create, update, and delete company entities.


      Entities are the building blocks of Company Watchlist. Each entity
      represents

      a company (or person) you want to track. Add identifying information such
      as

      domain, alternative names, and key persons to improve matching quality.
    externalDocs:
      description: Learn about Company Watchlist and entities
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/company-search
  - name: Datasets
    description: >
      Operations to create and manage datasets of entities.


      A dataset is a named collection of entities — think of it as a watchlist
      or

      portfolio. Connect a dataset to a job via `connected_dataset_ids` to
      activate

      Company Watchlist. Datasets can be reused across multiple jobs and
      monitors.
    externalDocs:
      description: Learn about datasets and Company Watchlist
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/company-search
  - name: Projects
    description: |
      Operations to create, organize, and manage projects.

      A project is a named container for jobs, monitors, and datasets. Group
      related resources by use case, team, or client, and share them with
      teammates. Resources can be assigned at creation time or post-hoc.
    externalDocs:
      description: Learn about projects and resource organization
      url: >-
        https://www.newscatcherapi.com/docs/web-search-api/guides-and-concepts/projects
  - name: Meta
    description: Operations to check API health and version.
externalDocs:
  description: Find out more about NewsCatcher CatchAll API
  url: https://www.newscatcherapi.com/docs/web-search-api/get-started/introduction
paths:
  /catchAll/datasets:
    get:
      tags:
        - Datasets
      summary: List datasets
      description: >
        Returns a paginated list of datasets belonging to the authenticated
        organization. Supports filtering by status and sorting by name, status,
        or creation date.
      operationId: listDatasets
      parameters:
        - $ref: '#/components/parameters/Page'
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: Number of datasets per page.
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Filter datasets by name (case-insensitive substring match).
          example: Portfolio
        - name: latest_status
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/DatasetStatus'
          description: |
            Filter by dataset status.
        - name: sort_by
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/DatasetSortBy'
        - name: sort_order
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/SortOrder'
        - $ref: '#/components/parameters/Ownership'
        - $ref: '#/components/parameters/ProjectIdQuery'
      responses:
        '200':
          $ref: '#/components/responses/DatasetListResponse'
        '403':
          $ref: '#/components/responses/ForbiddenError'
components:
  parameters:
    Page:
      name: page
      in: query
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
      description: |
        Page number to retrieve.
    Ownership:
      name: ownership
      in: query
      required: false
      schema:
        $ref: '#/components/schemas/OwnershipFilter'
    ProjectIdQuery:
      name: project_id
      in: query
      required: false
      description: Filter results to resources belonging to this project.
      schema:
        type: string
        format: uuid
      example: 60a85db4-78ec-4b78-876a-bc7d9cdadd04
  schemas:
    DatasetStatus:
      type: string
      enum:
        - pending
        - enriching
        - ready
        - failed
      description: |
        Processing status of a dataset.

        - `pending`: Dataset created, entities queued for enrichment.
        - `enriching`: Entities are being enriched.
        - `ready`: All entities enriched and indexed — ready for use in jobs.
        - `failed`: One or more entity enrichments failed.
    DatasetSortBy:
      type: string
      enum:
        - name
        - created_at
        - status
      description: Fields available for sorting dataset list results.
      default: created_at
    SortOrder:
      type: string
      enum:
        - asc
        - desc
      description: |
        Sort direction for list results.

        - `asc`: ascending (oldest or smallest first)
        - `desc`: descending (newest or largest first)
      default: desc
    OwnershipFilter:
      type: string
      enum:
        - all
        - own
        - shared
      default: all
      description: |
        Controls which resources are returned based on ownership.

        - `all`: Returns resources owned by the user and resources shared
          with them (default, backward compatible).
        - `own`: Returns only resources created by the authenticated user.
        - `shared`: Returns only resources shared with the user by others.
    DatasetListResponse:
      type: object
      required:
        - datasets
        - total
        - page
        - page_size
      properties:
        datasets:
          type: array
          items:
            $ref: '#/components/schemas/DatasetResponse'
          description: Array of dataset objects for this page.
        total:
          type: integer
          description: Total number of datasets matching the filter criteria.
          example: 5
        page:
          type: integer
          description: Current page number.
          example: 1
        page_size:
          type: integer
          description: Number of datasets per page.
          example: 100
    Error:
      type: object
      properties:
        detail:
          type: string
          description: Error message.
          example: Invalid API key
    DatasetResponse:
      type: object
      required:
        - id
        - organization_id
        - name
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the dataset.
          example: ccabb755-afc2-4047-b84c-78d1f23d49b2
        organization_id:
          type: string
          format: uuid
          description: Organization that owns this dataset.
          example: e5d9e9b0-e415-4941-8ef0-916c5ee56207
        name:
          type: string
          description: Dataset name.
          example: My Portfolio
        description:
          type:
            - string
            - 'null'
          description: Optional description.
          example: Companies in our investment portfolio
        entity_count:
          type: integer
          description: Total number of entities in this dataset.
          default: 0
          example: 4
        entity_status_breakdown:
          type: object
          additionalProperties:
            type: integer
          description: >
            Count of entities grouped by processing status. Keys are status
            values

            (`ready`, `pending`, `enriching`, `failed`); values are entity
            counts.
          example:
            ready: 4
        health_score:
          type: number
          description: >
            Overall health score of the dataset, from 0 to 100. Reflects how
            many

            entities have sufficient identifying information for reliable
            matching.
          example: 100
        health_breakdown:
          type: object
          additionalProperties:
            type: number
          description: |
            Health scores broken down by entity type. Keys are entity types
            (e.g. `company`); values are scores from 0 to 100.
          example:
            company: 100
        latest_status:
          $ref: '#/components/schemas/DatasetStatus'
        created_by_user_id:
          type: string
          format: uuid
          description: ID of the user who created this dataset.
          example: 870e258e-12ec-4a47-8656-e7a43b0265b3
        created_at:
          type: string
          format: date-time
          description: >
            ISO 8601 timestamp of when the dataset was created. Returned without
            timezone offset (server-local time).
          example: '2026-04-08T15:21:36.026993'
        updated_at:
          type: string
          format: date-time
          description: >
            ISO 8601 timestamp of when the dataset was last updated. Returned
            without timezone offset (server-local time).
          example: '2026-04-08T15:21:38.401148'
  responses:
    DatasetListResponse:
      description: Paginated list of datasets.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/DatasetListResponse'
    ForbiddenError:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication.

````