NationGraph Automations API

The Automations API from NationGraph — 12 operation(s) for automations.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 15 operations across 12 paths, and defines 44 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.

15 operations 12 paths 44 schemas 9 GET2 PATCH4 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

Authentication & Security 1

NationGraph Automations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 15

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

Automations 15

POST

/api/v3/automations

Create Automation

create_automation_api_v3_automations_post body → 200422

GET

/api/v3/automations

Get Automations

get_automations_api_v3_automations_get 9 params → 200422

GET

/api/v3/automations/types

Get Automation Types

get_automation_types_api_v3_automations_types_get 1 param → 200422

GET

/api/v3/automations/{automation_id}

Get Automation

get_automation_api_v3_automations__automation_id__get 1 param → 200422

PATCH

/api/v3/automations/{automation_id}

Update Automation

update_automation_api_v3_automations__automation_id__patch 1 param body → 200422

POST

/api/v3/automations/{automation_id}/refresh

Refresh

refresh_api_v3_automations__automation_id__refresh_post 1 param → 200422

POST

/api/v3/automations/{automation_id}/runs

Create And Run

create_and_run_api_v3_automations__automation_id__runs_post 1 param → 200422

GET

/api/v3/automations/{automation_id}/runs

Get Automation Runs

get_automation_runs_api_v3_automations__automation_id__runs_get 2 params → 200422

GET

/api/v3/automations/{automation_id}/runs/{run_id}

Get Run Detail

get_run_detail_api_v3_automations__automation_id__runs__run_id__get 2 params → 200422

PATCH

/api/v3/automations/{automation_id}/runs/{run_id}/status

Update Run Status

update_run_status_api_v3_automations__automation_id__runs__run_id__status_patch 2 params body → 200422

POST

/api/v3/automations/{automation_id}/runs/{run_id}/cancel

Cancel Run

cancel_run_api_v3_automations__automation_id__runs__run_id__cancel_post 2 params → 200422

GET

/api/v3/automations/{automation_id}/runs/{run_id}/results

Get Run Results

get_run_results_api_v3_automations__automation_id__runs__run_id__results_get 23 params → 200422

GET

/api/v3/automations/{automation_id}/runs/{run_id}/export

Export Run Csv

export_run_csv_api_v3_automations__automation_id__runs__run_id__export_get 21 params → 200422

GET

/api/v3/automations/{automation_id}/runs/{run_id}/contacts

Get Run Contacts

get_run_contacts_api_v3_automations__automation_id__runs__run_id__contacts_get 6 params → 200422

GET

/api/v3/automations/{automation_id}/runs/{run_id}/results/{result_id}/files

Get Result Files

get_result_files_api_v3_automations__automation_id__runs__run_id__results__result_id__files_get 3 params → 200422

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are EnrichedSignal (16 properties), ContactRow (13 properties), AutomationResultResponse (10 properties), InstitutionTypePayload (9 properties). Each schema is shown below with its type and property counts.

ContactsExportConfig

object

5 properties 2 required

AutomationRefreshResponse

object

1 property 1 required

InstitutionFiltersEnum

string

AutomationRunDetailResponse

object

8 properties 5 required

EnrichedSignal

object

16 properties 13 required

ValidationError

object

5 properties 3 required

SignalStatusEnum

string

AutomationWithStats

object

9 properties 8 required

CRMPushStatus

object

1 property

AutomationStatItem

object

2 properties 2 required

AutomationResponse

object

7 properties 7 required

AutomationResultResponse

object

10 properties 7 required

RunStatusUpdate

object

1 property 1 required

RankedInstitutionsConfig

object

3 properties 3 required

AutomationRunResponse

object

5 properties 4 required

InstitutionTypePayload

object

9 properties

AutomationExecutionStatus

string

AutomationStatus

string

DeepResearchQuery

object

5 properties 3 required

TerritoryVisibility

string

AutomationType

string

OutreachSequenceFilters

object

5 properties

UserProfileInstitutionFilter

object

4 properties 2 required

ContactRow

object

One flattened contact for the contactsexport contact-level results view. Mirrors the CSV columns (plus match/contactid) so the table and export stay in sync.

13 properties 2 required

RankedRanking

object

4 properties

PaginatedResponse_AutomationResultResponse_

object

4 properties 4 required

HTTPValidationError

object

1 property

DeepResearchConfig

object

4 properties 3 required

VendorContractEnrichmentConfig

object

6 properties 3 required

PaginatedResponse_ContactRow_

object

4 properties 4 required

InstitutionListPayload

object

4 properties 1 required

SignalSignificance

string

AutomationResultSortField

string

VendorWithProducts

object

2 properties 2 required

CRMType

string

Supported CRM integrations for institution mapping

LatestRunSummary

object

5 properties 4 required

SignalInstitution

object

4 properties 3 required

InstitutionEnum

string

CreateAutomationRequest

object

4 properties 3 required

AutomationStats

object

1 property 1 required

AutomationUpdates

object

3 properties

SignalSourceType

string

RankedInstitutionsFilters

object

2 properties

OutreachSequenceConfig

object

5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs NationGraph publishes across the network.

NationGraph Accounts 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

NationGraph CRM Leads API

AE Profile APIs.io

#Automations

← Back to N APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

NationGraph Automations API

Metadata

Authentication & Security 1

Paths & Operations 15

Schemas 44

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

NationGraph Automations API

Metadata

Authentication & Security 1

Paths & Operations 15

Schemas 44

Specification

Source

More from NationGraph 12

API Details

Provider

Explore more