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 Lists API

The Lists API from NationGraph — 4 operation(s) for lists.

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

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

This API exposes 9 operations across 4 paths, and defines 2 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.

9 operations 4 paths 2 schemas 3 DELETE2 GET1 PATCH3 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 Lists API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 9

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

Lists 9
GET
/api/v3/lists
Get Lists
get_lists_api_v3_lists_get → 200
POST
/api/v3/lists
Create List
create_list_api_v3_lists_post body → 200422
PATCH
/api/v3/lists/{list_id}
Edit List
edit_list_api_v3_lists__list_id__patch 1 param body → 200422
DELETE
/api/v3/lists/{list_id}
Delete List
delete_list_api_v3_lists__list_id__delete 1 param → 200422
POST
/api/v3/lists/{list_id}/signals/{signal_id}
Add Signal To List
add_signal_to_list_api_v3_lists__list_id__signals__signal_id__post 2 params → 200422
DELETE
/api/v3/lists/{list_id}/signals/{signal_id}
Remove Signal From List
remove_signal_from_list_api_v3_lists__list_id__signals__signal_id__delete 2 params → 200422
POST
/api/v3/lists/{list_id}/signals
Batch Add Signals To List
batch_add_signals_to_list_api_v3_lists__list_id__signals_post 1 param body → 200422
DELETE
/api/v3/lists/{list_id}/signals
Batch Remove Signals From List
batch_remove_signals_from_list_api_v3_lists__list_id__signals_delete 1 param body → 200422
GET
/api/v3/lists/{list_id}/signals
Get Signals In List
get_signals_in_list_api_v3_lists__list_id__signals_get 1 param → 200422

Schemas 2

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

ValidationError
object
5 properties 3 required
HTTPValidationError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nationgraph-lists-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