NationGraph Automations API
The Automations API from NationGraph — 12 operation(s) for automations.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/nationgraph-automations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Nationgraph Accounts Automations API
version: 0.2.36
servers:
- url: https://api.nationgraph.com
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Automations
paths:
/api/v3/automations:
post:
tags:
- Automations
summary: Create Automation
operationId: create_automation_api_v3_automations_post
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAutomationRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Automations
summary: Get Automations
operationId: get_automations_api_v3_automations_get
security:
- HTTPBearer: []
parameters:
- name: types
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/AutomationType'
- type: 'null'
title: Types
- name: statuses
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/AutomationStatus'
- type: 'null'
title: Statuses
- name: search
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search
- name: user_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: User Id
- name: live
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Live
- name: stopped
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Stopped
- name: include_stats
in: query
required: false
schema:
type: boolean
default: true
title: Include Stats
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: limit
in: query
required: false
schema:
type: integer
maximum: 200
minimum: 1
default: 50
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/types:
get:
tags:
- Automations
summary: Get Automation Types
operationId: get_automation_types_api_v3_automations_types_get
security:
- HTTPBearer: []
parameters:
- name: scheduled
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Scheduled
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
type: string
title: Response Get Automation Types Api V3 Automations Types Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/{automation_id}:
get:
tags:
- Automations
summary: Get Automation
operationId: get_automation_api_v3_automations__automation_id__get
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationWithStats'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Automations
summary: Update Automation
operationId: update_automation_api_v3_automations__automation_id__patch
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationUpdates'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/{automation_id}/refresh:
post:
tags:
- Automations
summary: Refresh
operationId: refresh_api_v3_automations__automation_id__refresh_post
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationRefreshResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/{automation_id}/runs:
post:
tags:
- Automations
summary: Create And Run
operationId: create_and_run_api_v3_automations__automation_id__runs_post
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationRunDetailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Automations
summary: Get Automation Runs
operationId: get_automation_runs_api_v3_automations__automation_id__runs_get
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
- name: statuses
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/AutomationExecutionStatus'
- type: 'null'
title: Statuses
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AutomationRunResponse'
title: Response Get Automation Runs Api V3 Automations Automation Id Runs Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/{automation_id}/runs/{run_id}:
get:
tags:
- Automations
summary: Get Run Detail
operationId: get_run_detail_api_v3_automations__automation_id__runs__run_id__get
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationRunDetailResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/{automation_id}/runs/{run_id}/status:
patch:
tags:
- Automations
summary: Update Run Status
operationId: update_run_status_api_v3_automations__automation_id__runs__run_id__status_patch
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RunStatusUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationRunResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/{automation_id}/runs/{run_id}/cancel:
post:
tags:
- Automations
summary: Cancel Run
operationId: cancel_run_api_v3_automations__automation_id__runs__run_id__cancel_post
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AutomationRunResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/{automation_id}/runs/{run_id}/results:
get:
tags:
- Automations
summary: Get Run Results
operationId: get_run_results_api_v3_automations__automation_id__runs__run_id__results_get
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: limit
in: query
required: false
schema:
type: integer
maximum: 200
minimum: 1
default: 50
title: Limit
- name: crm_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Crm Id
- name: sort
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/AutomationResultSortField'
- type: 'null'
title: Sort
- name: statuses
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/AutomationExecutionStatus'
- type: 'null'
title: Statuses
- name: institution_ids
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Institution Ids
- name: states
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: States
- name: crm_linked
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Crm Linked
- name: search
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search
- name: crm_pushed
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Crm Pushed
- name: crm_pushed_after
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Crm Pushed After
- name: crm_pushed_before
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Crm Pushed Before
- name: vendors
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Vendors
- name: products
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Products
- name: start_date_after
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: Start Date After
- name: start_date_before
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: Start Date Before
- name: end_date_after
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: End Date After
- name: end_date_before
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: End Date Before
- name: signal_setting_ids
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Signal Setting Ids
- name: data_sources
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/SignalSourceType'
- type: 'null'
title: Data Sources
- name: roles
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Roles
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResponse_AutomationResultResponse_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/{automation_id}/runs/{run_id}/export:
get:
tags:
- Automations
summary: Export Run Csv
operationId: export_run_csv_api_v3_automations__automation_id__runs__run_id__export_get
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
- name: crm_id
in: query
required: false
schema:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Crm Id
- name: sort
in: query
required: false
schema:
anyOf:
- $ref: '#/components/schemas/AutomationResultSortField'
- type: 'null'
title: Sort
- name: statuses
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/AutomationExecutionStatus'
- type: 'null'
title: Statuses
- name: institution_ids
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Institution Ids
- name: states
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: States
- name: crm_linked
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Crm Linked
- name: search
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search
- name: crm_pushed
in: query
required: false
schema:
anyOf:
- type: boolean
- type: 'null'
title: Crm Pushed
- name: crm_pushed_after
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Crm Pushed After
- name: crm_pushed_before
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Crm Pushed Before
- name: vendors
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Vendors
- name: products
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Products
- name: start_date_after
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: Start Date After
- name: start_date_before
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: Start Date Before
- name: end_date_after
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: End Date After
- name: end_date_before
in: query
required: false
schema:
anyOf:
- type: string
format: date
- type: 'null'
title: End Date Before
- name: signal_setting_ids
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Signal Setting Ids
- name: data_sources
in: query
required: false
schema:
anyOf:
- type: array
items:
$ref: '#/components/schemas/SignalSourceType'
- type: 'null'
title: Data Sources
- name: roles
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Roles
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/{automation_id}/runs/{run_id}/contacts:
get:
tags:
- Automations
summary: Get Run Contacts
operationId: get_run_contacts_api_v3_automations__automation_id__runs__run_id__contacts_get
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
default: 0
title: Offset
- name: limit
in: query
required: false
schema:
type: integer
maximum: 200
minimum: 1
default: 50
title: Limit
- name: search
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Search
- name: roles
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
title: Roles
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedResponse_ContactRow_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v3/automations/{automation_id}/runs/{run_id}/results/{result_id}/files:
get:
tags:
- Automations
summary: Get Result Files
operationId: get_result_files_api_v3_automations__automation_id__runs__run_id__results__result_id__files_get
security:
- HTTPBearer: []
parameters:
- name: automation_id
in: path
required: true
schema:
type: string
title: Automation Id
- name: run_id
in: path
required: true
schema:
type: string
title: Run Id
- name: result_id
in: path
required: true
schema:
type: string
title: Result Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
type: string
title: Response Get Result Files Api V3 Automations Automation Id Runs Run Id Results Result Id Files Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
AutomationStats:
properties:
items:
items:
$ref: '#/components/schemas/AutomationStatItem'
type: array
title: Items
type: object
required:
- items
title: AutomationStats
UserProfileInstitutionFilter:
properties:
id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Id
visibility:
$ref: '#/components/schemas/TerritoryVisibility'
default: private
type:
$ref: '#/components/schemas/InstitutionFiltersEnum'
payload:
anyOf:
- $ref: '#/components/schemas/InstitutionTypePayload'
- $ref: '#/components/schemas/InstitutionListPayload'
title: Payload
type: object
required:
- type
- payload
title: UserProfileInstitutionFilter
AutomationResponse:
properties:
id:
type: string
format: uuid
title: Id
name:
type: string
title: Name
type:
$ref: '#/components/schemas/AutomationType'
status:
$ref: '#/components/schemas/AutomationStatus'
config:
additionalProperties: true
type: object
title: Config
created_at:
type: string
format: date-time
title: Created At
updated_at:
type: string
format: date-time
title: Updated At
type: object
required:
- id
- name
- type
- status
- config
- created_at
- updated_at
title: AutomationResponse
SignalStatusEnum:
type: string
enum:
- active
- dismissed
- pending
- acknowledged
title: SignalStatusEnum
AutomationStatItem:
properties:
label:
type: string
title: Label
value:
type: string
title: Value
type: object
required:
- label
- value
title: AutomationStatItem
RankedRanking:
properties:
ng_score:
type: number
title: Ng Score
default: 0
population:
type: number
title: Population
default: 0
recency:
type: number
title: Recency
default: 0
signal_count:
type: number
title: Signal Count
default: 0
type: object
title: RankedRanking
DeepResearchConfig:
properties:
version:
type: string
title: Version
filters:
items:
$ref: '#/components/schemas/UserProfileInstitutionFilter'
type: array
title: Filters
queries:
items:
$ref: '#/components/schemas/DeepResearchQuery'
type: array
title: Queries
context:
anyOf:
- type: string
- type: 'null'
title: Context
type: object
required:
- version
- filters
- queries
title: DeepResearchConfig
OutreachSequenceFilters:
properties:
territories:
items:
$ref: '#/components/schemas/UserProfileInstitutionFilter'
type: array
title: Territories
default: []
signal_setting_ids:
items:
type: string
type: array
title: Signal Setting Ids
default: []
data_sources:
items:
$ref: '#/components/schemas/SignalSourceType'
type: array
title: Data Sources
default: []
signal_start_date:
anyOf:
- type: string
- type: 'null'
title: Signal Start Date
signal_end_date:
anyOf:
- type: string
- type: 'null'
title: Signal End Date
type: object
title: OutreachSequenceFilters
DeepResearchQuery:
properties:
id:
type: string
title: Id
query:
type: string
title: Query
output_type:
type: string
title: Output Type
column_name:
type: string
title: Column Name
options:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Options
type: object
required:
- query
- output_type
- column_name
title: DeepResearchQuery
InstitutionListPayload:
properties:
institution_ids:
items:
type: string
type: array
title: Institution Ids
name:
type: string
title: Name
original_filename:
anyOf:
- type: string
- type: 'null'
title: Original Filename
original_filter:
anyOf:
- $ref: '#/components/schemas/InstitutionTypePayload'
- type: 'null'
type: object
required:
- name
title: InstitutionListPayload
InstitutionFiltersEnum:
type: string
enum:
- institution_type
- institution_list
title: InstitutionFiltersEnum
OutreachSequenceConfig:
properties:
version:
type: string
title: Version
filters:
$ref: '#/components/schemas/OutreachSequenceFilters'
contact_titles_include:
items:
type: string
type: array
title: Contact Titles Include
default: []
contact_titles_exclude:
items:
type: string
type: array
title: Contact Titles Exclude
default: []
email_sequence_id:
type: string
title: Email Sequence Id
type: object
required:
- version
- filters
- email_sequence_id
title: OutreachSequenceConfig
AutomationUpdates:
properties:
name:
anyOf:
- type: string
- type: 'null'
title: Name
status:
anyOf:
- $ref: '#/components/schemas/AutomationStatus'
- type: 'null'
config:
anyOf:
- $ref: '#/components/schemas/RankedInstitutionsConfig'
- $ref: '#/components/schemas/VendorContractEnrichmentConfig'
- $ref: '#/components/schemas/OutreachSequenceConfig'
- $ref: '#/components/schemas/DeepResearchConfig'
- $ref: '#/components/schemas/ContactsExportConfig'
- type: 'null'
title: Config
type: object
title: AutomationUpdates
ContactsExportConfig:
properties:
version:
type: string
title: Version
filters:
items:
$ref: '#/components/schemas/UserProfileInstitutionFilter'
type: array
title: Filters
role_types:
items:
type: string
type: array
title: Role Types
default: []
exclude_titles:
items:
type: string
type: array
title: Exclude Titles
default: []
hard_match:
type: boolean
title: Hard Match
default: false
type: object
required:
- version
- filters
title: ContactsExportConfig
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
PaginatedResponse_AutomationResultResponse_:
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nationgraph/refs/heads/main/openapi/nationgraph-automations-api-openapi.yml