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

The User API from NationGraph — 7 operation(s) for user.

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

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

This API exposes 8 operations across 7 paths, and defines 13 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 7 paths 13 schemas 5 GET1 POST2 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 User API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 8

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

User 8
POST
/api/v3/users
Bootstrap User
bootstrap_user_api_v3_users_post → 200
GET
/api/v3/users/onboarding
Get User Onboarding Progress
get_user_onboarding_progress_api_v3_users_onboarding_get → 200
GET
/api/v3/users/{user_id}/subscriptions
Get Subscriptions For User
get_subscriptions_for_user_api_v3_users__user_id__subscriptions_get 1 param → 200422
GET
/api/v3/users/{user_id}/integrations
Get User Integrations
get_user_integrations_api_v3_users__user_id__integrations_get 2 params → 200422
GET
/api/v3/users/{user_id}/subscriptions/{subscription_type}
Get Subscriptions By Type
get_subscriptions_by_type_api_v3_users__user_id__subscriptions__subscription_type__get 3 params → 200422
PUT
/api/v3/users/{user_id}/documents/{document_id}
Add User Document
add_user_document_api_v3_users__user_id__documents__document_id__put 2 params → 200422
PUT
/api/v3/users/{user_id}/documents
Replace User Documents
replace_user_documents_api_v3_users__user_id__documents_put 1 param body → 200422
GET
/api/v3/users/{user_id}/documents
Get User Documents
get_user_documents_api_v3_users__user_id__documents_get 1 param → 200422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are IntegrationResponse (11 properties), ProviderIntegration (7 properties), OnboardingCompletedSteps (6 properties), ProviderCapabilities (5 properties). Each schema is shown below with its type and property counts.

DeliveryMethod
string
HTTPValidationError
object
1 property
ProviderCapabilities
object
5 properties
ProviderStatConfig
object
3 properties 3 required
ReplaceUserDocumentsRequest
object
1 property 1 required
OrganizationIntegrationGroup
object
4 properties 3 required
SubscriptionType
string
ValidationError
object
5 properties 3 required
IntegrationResponse
object
11 properties 10 required
OnboardingProgressResponse
object
4 properties 4 required
OnboardingCompletedSteps
object
6 properties 6 required
UserIntegrationsGroupedResponse
object
2 properties 2 required
ProviderIntegration
object
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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