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

NationGraph Signals API

The Signals API from NationGraph — 11 operation(s) for signals.

NationGraph Signals API is one of 56 APIs that NationGraph publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Signals. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 11 operations across 11 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 0.2.36.

Requests are made against the base URL https://api.nationgraph.com.

11 operations 11 paths 12 schemas 4 GET2 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.2.36
Base URL
https://api.nationgraph.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

NationGraph Signals API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 11

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

Signals 11
POST
/api/v3/signals/search
Search Signals
search_signals_api_v3_signals_search_post body → 200422
GET
/api/v3/signals/{signal_id}
Get Signal
get_signal_api_v3_signals__signal_id__get 1 param → 200422
GET
/api/v3/signals/{signal_id}/sources
Get Signal Data Sources
get_signal_data_sources_api_v3_signals__signal_id__sources_get 1 param → 200422
POST
/api/v3/signals/{signal_id}/users
Add User To Signal
add_user_to_signal_api_v3_signals__signal_id__users_post 1 param body → 200422
POST
/api/v3/signals/{signal_id}/actions
Create Signal User Action
create_signal_user_action_api_v3_signals__signal_id__actions_post 1 param body → 200422
POST
/api/v3/signals/actions
Batch Create Signal User Actions
batch_create_signal_user_actions_api_v3_signals_actions_post body → 200422
PATCH
/api/v3/signals/{signal_id}/status
Update Signal User Status
update_signal_user_status_api_v3_signals__signal_id__status_patch 1 param body → 200422
PATCH
/api/v3/signals/status
Batch Update Signal User Status
batch_update_signal_user_status_api_v3_signals_status_patch body → 200422
POST
/api/v3/signals/dismiss
Dismiss Signals
dismiss_signals_api_v3_signals_dismiss_post 16 params → 200422
GET
/api/v3/signals/{signal_id}/share
Create Signal Share Link
create_signal_share_link_api_v3_signals__signal_id__share_get 1 param → 200422
GET
/api/v3/signals/share/{signal_token}
Get Shared Signal
get_shared_signal_api_v3_signals_share__signal_token__get 1 param → 200422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are SignalFilters (19 properties), ValidationError (5 properties), Body_batch_create_signal_user_actions_api_v3_signals_actions_post (3 properties), Body_create_signal_user_action_api_v3_signals__signal_id__actions_post (2 properties). Each schema is shown below with its type and property counts.

SignalSortEnum
string
InstitutionEnum
string
Body_create_signal_user_action_api_v3_signals__signal_id__actions_post
object
2 properties 1 required
HTTPValidationError
object
1 property
SignalUserActionEnum
string
InstitutionSortEnum
string
Sort order for institutions in paginated response. Note: This sorting is applied per-page after signal-level pagination. The same institution may appear on mul…
ValidationError
object
5 properties 3 required
SignalStatusEnum
string
SignalSourceType
string
SignalFilters
object
19 properties
Body_batch_create_signal_user_actions_api_v3_signals_actions_post
object
3 properties 2 required
Body_batch_update_signal_user_status_api_v3_signals_status_patch
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nationgraph-signals-api-openapi.yml Raw ↑

Other APIs NationGraph publishes across the network.

NationGraph Accounts API
NationGraph Automations API
NationGraph Budgets API
NationGraph Classifier API
NationGraph Classifiers API
NationGraph Contacts API
NationGraph Contracts API
NationGraph CRM API
NationGraph CRM Automation Push API
NationGraph CRM Companies API
NationGraph CRM Contacts API
NationGraph CRM History API