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

The Territories API from NationGraph — 4 operation(s) for territories.

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

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

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

6 operations 4 paths 11 schemas 1 DELETE2 GET2 POST1 PUT

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 Territories API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 6

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

Territories 6
GET
/api/v3/territories/stats
Get Territory Stats
get_territory_stats_api_v3_territories_stats_get → 200
GET
/api/v3/territories
List Territories
list_territories_api_v3_territories_get 3 params → 200422
POST
/api/v3/territories
Create Territory
create_territory_api_v3_territories_post body → 201422
POST
/api/v3/territories/preview
Preview Territory
preview_territory_api_v3_territories_preview_post body → 200422
PUT
/api/v3/territories/{filter_id}
Update Territory
update_territory_api_v3_territories__filter_id__put 1 param body → 200422
DELETE
/api/v3/territories/{filter_id}
Delete Territory
delete_territory_api_v3_territories__filter_id__delete 1 param → 204422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are InstitutionTypePayload (9 properties), TerritoryListItem (7 properties), TerritoryAccountItem (7 properties), ValidationError (5 properties). Each schema is shown below with its type and property counts.

TerritoryAccountItem
object
One institution row in a territory preview sample.
7 properties 7 required
HTTPValidationError
object
1 property
InstitutionFiltersEnum
string
TerritoryPreviewResponse
object
2 properties 2 required
ValidationError
object
5 properties 3 required
TerritoryListResponse
object
2 properties 2 required
InstitutionTypePayload
object
9 properties
InstitutionListPayload
object
4 properties 1 required
TerritoryListItem
object
One row in the GET /territories list response. Visibility column lives in the DB but is intentionally not exposed here — future-sprint feature per boss; the AP…
7 properties 7 required
TerritoryVisibility
string
UserProfileInstitutionFilter
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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