Projects

A project is a named container for jobs, event monitors, datasets, and webhooks. Use projects to separate work by use case, team, or client — and to share that work with teammates across your organization.

How it works

Resources can be assigned to a project in two ways:

At creation time — include project_id in the request body of any create endpoint for jobs, event monitors, datasets, or webhooks.
Post-hoc — use the Add resources endpoint to assign one or more existing resources by type and ID.

Valid resource_type values are job, monitor, dataset, monitor_group, and webhook. Most resources belong to at most one project. Webhooks are the exception: the same webhook can be attached to several projects at once, since one endpoint often serves multiple workstreams. Entities cannot be assigned to projects — they are shared across the entire organization.

Create a project

curl -X POST "https://catchall.newscatcherapi.com/catchAll/projects" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "AI M&A Tracking",
    "description": "Tracks AI-related M&A activity for our investment team."
  }'

from newscatcher_catchall import CatchAllApi

client = CatchAllApi(api_key="YOUR_API_KEY")

project = client.projects.create_project(
    name="AI M&A Tracking",
    description="Tracks AI-related M&A activity for our investment team.",
)
project_id = project.project_id

import { CatchAllApiClient } from "newscatcher-catchall-sdk";

const client = new CatchAllApiClient({ apiKey: "YOUR_API_KEY" });

const project = await client.projects.createProject({
  name: "AI M&A Tracking",
  description: "Tracks AI-related M&A activity for our investment team.",
});
const projectId = project.project_id;

import com.newscatcher.catchall.CatchAllApi;
import com.newscatcher.catchall.resources.projects.requests.CreateProjectRequestDto;

CatchAllApi client = CatchAllApi.builder()
    .apiKey("YOUR_API_KEY")
    .build();

var project = client.projects().createProject(
    CreateProjectRequestDto.builder()
        .name("AI M&A Tracking")
        .description("Tracks AI-related M&A activity for our investment team.")
        .build()
);
String projectId = project.getProjectId();

Response:

{
  "success": true,
  "message": "Project created successfully.",
  "project_id": "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
  "name": "AI M&A Tracking"
}

Assign resources

Pass project_id in the request body at creation time:

cURL

curl -X POST "https://catchall.newscatcherapi.com/catchAll/submit" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "AI acquisitions and mergers Q2 2026",
    "project_id": "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
  }'

Webhooks accept project_id on creation in the same way:

cURL

curl -X POST "https://catchall.newscatcherapi.com/catchAll/webhooks" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "AI M&A Alerts",
    "url": "https://hooks.slack.com/services/T000/B000/xxx",
    "type": "slack",
    "project_id": "60a85db4-78ec-4b78-876a-bc7d9cdadd04"
  }'

If the project_id does not exist, the request fails with 404. If it belongs to another organization, it fails with 403; in both cases the webhook is not created. To add an existing resource post-hoc:

cURL

curl -X POST "https://catchall.newscatcherapi.com/catchAll/projects/60a85db4-78ec-4b78-876a-bc7d9cdadd04/resources" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "resources": [
      {
        "resource_type": "job",
        "resource_id": "48421e16-1f50-4048-b62c-d3bc0789d30d"
      },
      {
        "resource_type": "webhook",
        "resource_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    ]
  }'

Filter by project

All list endpoints accept a project_id query parameter to return only resources belonging to a specific project:

Jobs
Event Monitors
Datasets
Webhooks

curl "https://catchall.newscatcherapi.com/catchAll/jobs/user?project_id=60a85db4-78ec-4b78-876a-bc7d9cdadd04" \
  -H "x-api-key: YOUR_API_KEY"

curl "https://catchall.newscatcherapi.com/catchAll/monitors?project_id=60a85db4-78ec-4b78-876a-bc7d9cdadd04" \
  -H "x-api-key: YOUR_API_KEY"

curl "https://catchall.newscatcherapi.com/catchAll/datasets?project_id=60a85db4-78ec-4b78-876a-bc7d9cdadd04" \
  -H "x-api-key: YOUR_API_KEY"

The webhook list endpoint does not take project_id. List a project’s webhooks through the project resources endpoint instead:

curl "https://catchall.newscatcherapi.com/catchAll/projects/60a85db4-78ec-4b78-876a-bc7d9cdadd04/resources?resource_type=webhook" \
  -H "x-api-key: YOUR_API_KEY"

Get a project overview

Returns resource counts grouped by type and status — useful for dashboards without fetching full resource lists:

cURL

curl "https://catchall.newscatcherapi.com/catchAll/projects/60a85db4-78ec-4b78-876a-bc7d9cdadd04/overview" \
  -H "x-api-key: YOUR_API_KEY"

{
  "project_id": "60a85db4-78ec-4b78-876a-bc7d9cdadd04",
  "overview": {
    "jobs": {
      "completed": 12,
      "failed": 1,
      "analyzing": 2
    },
    "monitors": {
      "completed": 3
    },
    "datasets": {
      "total": 2
    },
    "monitor_groups": {
      "total": 0
    },
    "webhooks": {
      "total": 1
    }
  }
}

For jobs and monitors, keys are status values with integer counts. For datasets, monitor_groups, and webhooks, only a total count is returned.

Delete a project

By default, deleting a project unassigns its resources — they continue to exist without a project association. Set delete_resources=true to permanently delete all assigned resources along with the project. Webhooks are never deleted by either option. An attached webhook is only detached from the project and keeps delivering, because the same webhook may still be attached to other projects. To remove a webhook itself, call Delete webhook.

Unassign resources (default)
Delete project and resources

curl -X DELETE "https://catchall.newscatcherapi.com/catchAll/projects/60a85db4-78ec-4b78-876a-bc7d9cdadd04" \
  -H "x-api-key: YOUR_API_KEY"

curl -X DELETE "https://catchall.newscatcherapi.com/catchAll/projects/60a85db4-78ec-4b78-876a-bc7d9cdadd04?delete_resources=true" \
  -H "x-api-key: YOUR_API_KEY"

delete_resources=true permanently deletes all jobs, event monitors, datasets, and event monitor groups assigned to the project. This operation cannot be undone. Webhooks are detached rather than deleted.

Get started

Concepts

How to

API Reference

Integrations

Libraries

How it works

Create a project

Assign resources

Filter by project

Get a project overview

Delete a project

See also

​How it works

​Create a project

​Assign resources

​Filter by project

​Get a project overview

​Delete a project

​See also

How it works

Create a project

Assign resources

Filter by project

Get a project overview

Delete a project

See also