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

The Institutions API from NationGraph — 6 operation(s) for institutions.

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

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

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

8 operations 6 paths 14 schemas 1 DELETE4 GET3 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 Institutions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 8

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

Institutions 8
GET
/api/v3/workspaces/institutions
Get Institutions In Workspace
get_institutions_in_workspace_api_v3_workspaces_institutions_get 1 param → 200422
POST
/api/v3/workspaces/{workspace_id}/institutions
Add Institution To Workspace
add_institution_to_workspace_api_v3_workspaces__workspace_id__institutions_post 1 param body → 200422
DELETE
/api/v3/workspaces/{workspace_id}/institutions
Delete Workspace Institutions
delete_workspace_institutions_api_v3_workspaces__workspace_id__institutions_delete 1 param body → 200422
GET
/api/v3/workspaces/{workspace_id}/institutions
Get Workspace Institutions
get_workspace_institutions_api_v3_workspaces__workspace_id__institutions_get 1 param → 200422
POST
/api/v3/institutions/count
Get Institution Count
get_institution_count_api_v3_institutions_count_post body → 200422
POST
/api/v3/institutions/metadata
Get Institution Metadata
get_institution_metadata_api_v3_institutions_metadata_post body → 200422
GET
/api/v3/institutions
Get Institutions
get_institutions_api_v3_institutions_get 10 params → 200422
GET
/api/v3/institutions/{institution_id}
Get Institution
get_institution_api_v3_institutions__institution_id__get 1 param → 200422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are InstitutionFilter (10 properties), InstitutionTypePayload (9 properties), ValidationError (5 properties), UserProfileInstitutionFilter (4 properties). Each schema is shown below with its type and property counts.

InstitutionFilter
object
Query parameters for filtering institutions.
10 properties
HTTPValidationError
object
1 property
InstitutionFiltersEnum
string
InstitutionCountRequest
object
Request for the filtered institution count endpoint.
2 properties 2 required
ValidationError
object
5 properties 3 required
InstitutionTypePayload
object
9 properties
SignalSourceType
string
InstitutionsRequest
object
2 properties 1 required
InstitutionListPayload
object
4 properties 1 required
InstitutionSignalFilters
object
4 properties
TerritoryVisibility
string
CreateInstitutionsRequest
object
1 property 1 required
UserProfileInstitutionFilter
object
4 properties 2 required
InstitutionCountsRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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