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 CRM Mappings API

The CRM Mappings API from NationGraph — 4 operation(s) for crm mappings.

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

Tagged areas include CRM Mappings. 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 DELETE3 GET2 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 CRM Mappings 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, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

CRM Mappings 6
GET
/api/v3/crm/{integration_id}/mappings
List Mappings
list_mappings_api_v3_crm__integration_id__mappings_get 3 params → 200422
POST
/api/v3/crm/{integration_id}/mappings
Create Mappings
create_mappings_api_v3_crm__integration_id__mappings_post 1 param body → 202422
DELETE
/api/v3/crm/{integration_id}/mappings
Delete Mappings
delete_mappings_api_v3_crm__integration_id__mappings_delete 1 param body → 200422
GET
/api/v3/crm/{integration_id}/mappings/export
Export Mappings CSV
export_mappings_csv_api_v3_crm__integration_id__mappings_export_get 1 param → 200422
POST
/api/v3/crm/{integration_id}/mappings/push-nationgraph-ids
Push NationGraph IDs to CRM
push_nationgraph_ids_api_v3_crm__integration_id__mappings_push_nationgraph_ids_post 1 param body → 202422
GET
/api/v3/crm/{integration_id}/institutions/{institution_id}/contacts
Get CRM Contacts for Institution
get_crm_contacts_for_institution_api_v3_crm__integration_id__institutions__institution_id__contacts_get 3 params → 200422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CRMContactResponse (8 properties), MappingResponse (6 properties), ValidationError (5 properties), MappingListResponse (4 properties). Each schema is shown below with its type and property counts.

CRMType
string
Supported CRM integrations for institution mapping
BulkCreateAcceptedResponse
object
Response for accepted bulk mapping creation (202).
2 properties 1 required
PushNationGraphIdsRequest
object
Request to push NationGraph IDs to a chosen CRM field.
2 properties 1 required
HTTPValidationError
object
1 property
MappingResponse
object
API response for a CRM institution mapping.
6 properties 5 required
ValidationError
object
5 properties 3 required
MappingListResponse
object
API response for listing mappings.
4 properties 2 required
CRMContactResponse
object
A CRM contact.
8 properties 1 required
InstitutionContactsResponse
object
Response for contacts associated with a CRM company.
3 properties 3 required
BulkDeleteMappingsRequest
object
Request to delete one or more CRM institution mappings.
1 property 1 required
BulkDeleteMappingsResponse
object
Response for bulk mapping deletion.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nationgraph-crm-mappings-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