Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Newscatcher Projects API

Operations to create, organize, and manage projects.A project is a named container for jobs, monitors, and datasets. Grouprelated resources by use case, team, or client, and share them withteammates. Resources can be assigned at creation time or post-hoc.

Newscatcher Projects API is one of 16 APIs that Newscatcher publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Projects. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 5 paths, and defines 21 schemas. It is described by OpenAPI 3.0.3, at version 1.2.0.

Requests are made against a single base URL, https://local-news.newscatcherapi.com.

9 operations 5 paths 21 schemas 2 DELETE4 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.2.0
Base URL
https://v3-api.newscatcherapi.com/api
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Newscatcher Projects API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-token (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API Key to authenticate requests. To access the API, include your API key in the x-api-token header. To obtain your API key, complete the [form](https://www.ne…

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Projects 9

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 sha…

POST
/catchAll/projects
Create project
createProject body → 201403422
GET
/catchAll/projects
List projects
listProjects 4 params → 200403422
GET
/catchAll/projects/{project_id}
Get project
getProject 1 param → 200403404
PATCH
/catchAll/projects/{project_id}
Update project
updateProject 1 param body → 200403404422
DELETE
/catchAll/projects/{project_id}
Delete project
deleteProject 2 params → 204403404
GET
/catchAll/projects/{project_id}/overview
Get project overview
getProjectOverview 1 param → 200403404
POST
/catchAll/projects/{project_id}/resources
Add resources to project
addResourceToProject 1 param body → 200201400403404
GET
/catchAll/projects/{project_id}/resources
List project resources
listProjectResources 4 params → 200403404422
DELETE
/catchAll/projects/{project_id}/resources/{resource_type}/{resource_id}
Remove resource from project
removeResourceFromProject 3 params → 200403404

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are ProjectResponseDto (8 properties), ProjectSummaryDto (6 properties), ProjectResourceListResponseDto (5 properties), ResourceResultDto (5 properties). Each schema is shown below with its type and property counts.

ProjectOverviewResponseDto
object
2 properties 2 required
RemoveResourceResponseDto
object
2 properties 2 required
ValidationErrorDetail
object
3 properties
ProjectResponseDto
object
8 properties 4 required
ResourceResultDto
object
5 properties 4 required
ProjectResourceType
string
Resource type for project association.
ProjectSummaryDto
object
Abbreviated project object returned in list responses.
6 properties 2 required
ResourceItemDto
object
2 properties 2 required
ValidationErrorResponse
object
1 property
UpdateProjectRequestDto
object
Updates one or more fields of an existing project. At least one field must be provided.
2 properties
ProjectResourceDto
object
A resource assigned to a project.
5 properties 2 required
ProjectResourceListResponseDto
object
5 properties 5 required
Error
object
1 property
CreateProjectRequestDto
object
2 properties 1 required
ProjectListResponseDto
object
5 properties 5 required
UpdateProjectResponseDto
object
3 properties 3 required
ProjectOverviewCountsDto
object
Status breakdown for a single resource type.
AddResourceRequestDto
object
1 property 1 required
CreateProjectResponseDto
object
4 properties 4 required
AddResourceResponseDto
object
3 properties 3 required
OwnershipFilter
string
Controls which resources are returned based on ownership. - all: Returns resources owned by the user and resources shared with them (default, backward compatib…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newscatcher-projects-api-openapi.yml Raw ↑

Other APIs Newscatcher publishes across the network.

Newscatcher AggregationCount API
Newscatcher Authors API
Newscatcher BreakingNews API
Newscatcher Datasets API
Newscatcher Entities API
Newscatcher Jobs API
Newscatcher LatestHeadlines API
Newscatcher Meta API
Newscatcher Monitors API
Newscatcher Search API
Newscatcher SearchBy API
Newscatcher SearchByLink API