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

Netter

Netter automations API

The automations API from Netter — 11 operation(s) for automations.

Documentation Provider Profile APIs.io OpenAPI GitHub

Netter automations API is one of 44 APIs that Netter 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, API documentation, and an API reference.

This API exposes 14 operations across 11 paths, and defines 20 schemas. It is described by OpenAPI 3.1.0, at version 0.1.0.

Requests are made against the base URL https://api.netter.ai.

14 operations 11 paths 20 schemas 1 DELETE4 GET1 PATCH6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.1.0
Base URL
https://api.netter.ai
Resource Areas
1

Paths & Operations 14

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

automations 14
POST
/api/v1/automations
Create Automation
create_automation_api_v1_automations_post body → 201422
GET
/api/v1/automations
List Automations
list_automations_api_v1_automations_get 2 params → 200422
GET
/api/v1/automations/{automation_id}
Get Automation
get_automation_api_v1_automations__automation_id__get 1 param → 200422
PATCH
/api/v1/automations/{automation_id}
Update Automation
update_automation_api_v1_automations__automation_id__patch 1 param body → 204422
PUT
/api/v1/automations/{automation_id}/favorite
Favorite Automation
favorite_automation_api_v1_automations__automation_id__favorite_put 1 param → 200422
DELETE
/api/v1/automations/{automation_id}/favorite
Unfavorite Automation
unfavorite_automation_api_v1_automations__automation_id__favorite_delete 1 param → 200422
PUT
/api/v1/automations/{automation_id}/nodes/{slug}/config
Update Node Config
update_node_config_api_v1_automations__automation_id__nodes__slug__config_put 2 params body → 204422
POST
/api/v1/automations/{automation_id}/suppress
Suppress Automation
suppress_automation_api_v1_automations__automation_id__suppress_post 1 param → 204422
POST
/api/v1/automations/{automation_id}/unsuppress
Unsuppress Automation
unsuppress_automation_api_v1_automations__automation_id__unsuppress_post 1 param → 204422
POST
/api/v1/automations/{automation_id}/activate
Activate Automation
activate_automation_api_v1_automations__automation_id__activate_post 1 param → 204422
POST
/api/v1/automations/{automation_id}/deactivate
Deactivate Automation
deactivate_automation_api_v1_automations__automation_id__deactivate_post 1 param → 204422
POST
/api/v1/automations/{automation_id}/run
Run Automation Now
run_automation_now_api_v1_automations__automation_id__run_post 1 param body → 202422
GET
/api/v1/automations/{automation_id}/runs
List Automation Runs
list_automation_runs_api_v1_automations__automation_id__runs_get 2 params → 200422
GET
/api/v1/automations/{automation_id}/runs/{run_id}
Get Automation Run
get_automation_run_api_v1_automations__automation_id__runs__run_id__get 2 params → 200422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are AutomationRead (14 properties), app__automations__schemas__RunRead (10 properties), NodeRunRead (10 properties), NodeRead (6 properties). Each schema is shown below with its type and property counts.

NodeRunStatus
string
Status of a single node execution within a run.
RunNowResponse
object
1 property 1 required
NodeCreate
object
5 properties 2 required
NodeRead
object
6 properties 6 required
AutomationUpdate
object
4 properties
PermissionLevel
string
Permission tiers, strictly ordered VIEWER < EDITOR < ADMIN.
RunDetailRead
object
2 properties 2 required
EdgeRead
object
4 properties 4 required
RunStatus
string
Status of an automation run (one fire).
NodeConfigUpdate
object
Direct edit of a node's config payload — bypasses the architect chat. The new dict replaces the existing config wholesale (no shallow merge); validation runs t…
1 property 1 required
NodeRunRead
object
10 properties 10 required
AutomationRead
object
14 properties 12 required
ValidationError
object
5 properties 3 required
AutomationCreate
object
4 properties 3 required
HTTPValidationError
object
1 property
EdgeCreate
object
3 properties 2 required
app__automations__schemas__RunRead
object
10 properties 10 required
AutomationStatus
string
Top-level status of an automation.
AutomationRunRequest
object
Optional body for POST /automations/{id}/run ("Run now"). input carries the values for a trigger.appinvocation input schema (the same shape the app-button endp…
1 property
NodeKind
string
All v1 node kinds. Triggers + body nodes share one enum + one table.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netter-automations-api-openapi.yml Raw ↑

Other APIs Netter publishes across the network.

Netter actions API
AE Profile APIs.io
Netter api-keys API
AE Profile APIs.io
Netter app-chat API
AE Profile APIs.io
Netter apps API
AE Profile APIs.io
Netter apps-query API
AE Profile APIs.io
Netter assistant API
AE Profile APIs.io
Netter attributes API
AE Profile APIs.io
Netter chats API
AE Profile APIs.io
Netter companies API
AE Profile APIs.io
Netter dashboard-chat API
AE Profile APIs.io
Netter dashboard-data API
AE Profile APIs.io
Netter dashboard-versions API
AE Profile APIs.io
#automations
← Back to N APIs
API Details
ID
netter:netter-automations-api
Base URL
https://api.netter.ai
Docs
https://netter.ai/docs/api/overview.md
Provider
Netter
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network