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

The User Profile API from NationGraph — 3 operation(s) for user profile.

NationGraph User Profile 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 Profile. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

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

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

Paths & Operations 4

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

User Profile 4
GET
/api/v3/user-profiles/{user_id}
Get User Profile
get_user_profile_api_v3_user_profiles__user_id__get 1 param → 200422
PATCH
/api/v3/user-profiles/{user_id}
Update User Profile
update_user_profile_api_v3_user_profiles__user_id__patch 1 param body → 200422
POST
/api/v3/user-profiles/documents/search
Search User Profile Documents
search_user_profile_documents_api_v3_user_profiles_documents_search_post body → 200422
POST
/api/v3/user-profiles/{user_id}/document-summary
Generate User Document Summary
generate_user_document_summary_api_v3_user_profiles__user_id__document_summary_post 1 param → 200422

Schemas 9

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

HTTPValidationError
object
1 property
InstitutionFiltersEnum
string
ValidationError
object
5 properties 3 required
InstitutionTypePayload
object
9 properties
InstitutionListPayload
object
4 properties 1 required
Body_search_user_profile_documents_api_v3_user_profiles_documents_search_post
object
1 property 1 required
TerritoryVisibility
string
UserProfileInstitutionFilter
object
4 properties 2 required
UserProfileRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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