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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

NationGraph

NationGraph CRM Leads API

The CRM Leads API from NationGraph — 4 operation(s) for crm leads.

Documentation Provider Profile APIs.io OpenAPI GitHub

NationGraph CRM Leads 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 Leads. 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 8 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 8 schemas 3 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 CRM Leads 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 — 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

CRM Leads 6
GET
/api/v3/crm/{integration_id}/leads
List Leads
list_leads_api_v3_crm__integration_id__leads_get 4 params → 200422
POST
/api/v3/crm/{integration_id}/leads
Create Lead
create_lead_api_v3_crm__integration_id__leads_post 1 param body → 200422
GET
/api/v3/crm/{integration_id}/leads/{lead_id}
Get Lead
get_lead_api_v3_crm__integration_id__leads__lead_id__get 3 params → 200422
PATCH
/api/v3/crm/{integration_id}/leads/{lead_id}
Update Lead
update_lead_api_v3_crm__integration_id__leads__lead_id__patch 2 params body → 200422
GET
/api/v3/crm/{integration_id}/leads/search
Search Leads
search_leads_api_v3_crm__integration_id__leads_search_get 8 params → 200422
POST
/api/v3/crm/{integration_id}/leads/{lead_id}/convert
Convert Lead
convert_lead_api_v3_crm__integration_id__leads__lead_id__convert_post 2 params body → 200422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CreateLeadRequest (21 properties), UpdateLeadRequest (21 properties), ConvertLeadRequest (6 properties), ValidationError (5 properties). Each schema is shown below with its type and property counts.

ConvertLeadResponse
object
Response from converting a lead.
5 properties 4 required
LeadListAPIResponse
object
API response for listing leads.
3 properties 2 required
HTTPValidationError
object
1 property
CreateLeadRequest
object
Request to create a lead in Salesforce. LastName and Company are required. All other fields are optional.
21 properties 2 required
LeadResponse
object
API response for a single lead.
2 properties 2 required
ValidationError
object
5 properties 3 required
ConvertLeadRequest
object
Request to convert a lead to Account, Contact, and optionally Opportunity.
6 properties
UpdateLeadRequest
object
Request to update a lead in Salesforce. All fields are optional - only include fields you want to update.
21 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nationgraph-crm-leads-api-openapi.yml Raw ↑

Other APIs NationGraph publishes across the network.

NationGraph Accounts API
AE Profile APIs.io
NationGraph Automations API
AE Profile APIs.io
NationGraph Budgets API
AE Profile APIs.io
NationGraph Classifier API
AE Profile APIs.io
NationGraph Classifiers API
AE Profile APIs.io
NationGraph Contacts API
AE Profile APIs.io
NationGraph Contracts API
AE Profile APIs.io
NationGraph CRM API
AE Profile APIs.io
NationGraph CRM Automation Push API
AE Profile APIs.io
NationGraph CRM Companies API
AE Profile APIs.io
NationGraph CRM Contacts API
AE Profile APIs.io
NationGraph CRM History API
AE Profile APIs.io
#CRM Leads
← Back to N APIs
API Details
ID
nationgraph:nationgraph-crm-leads-api
Base URL
https://api.nationgraph.com
Docs
https://api.nationgraph.com/docs
Provider
NationGraph
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network