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 actions API

The actions API from Netter — 7 operation(s) for actions.

Documentation Provider Profile APIs.io OpenAPI GitHub

Netter actions API is one of 44 APIs that Netter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include actions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 7 paths, and defines 27 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.

9 operations 7 paths 27 schemas 4 GET1 PATCH4 POST

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 9

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

actions 9
POST
/api/v1/actions/{action_type}/invoke
Invoke Action
invoke_action_api_v1_actions__action_type__invoke_post 1 param body → 200422
POST
/api/v1/actions
Create Action
create_action_api_v1_actions_post body → 201422
GET
/api/v1/actions
List Actions
list_actions_api_v1_actions_get 1 param → 200422
GET
/api/v1/actions/runnable
List Runnable
list_runnable_api_v1_actions_runnable_get 1 param → 200422
GET
/api/v1/actions/invocations
List Invocations
list_invocations_api_v1_actions_invocations_get 2 params → 200422
POST
/api/v1/actions/{action_id}/invoke
Invoke Action Endpoint
invoke_action_endpoint_api_v1_actions__action_id__invoke_post 1 param body → 200422
GET
/api/v1/actions/{action_id}
Get Action
get_action_api_v1_actions__action_id__get 1 param → 200422
PATCH
/api/v1/actions/{action_id}
Update Action
update_action_api_v1_actions__action_id__patch 1 param body → 204422
POST
/api/v1/actions/{action_id}/archive
Archive Action
archive_action_api_v1_actions__action_id__archive_post 1 param → 204422

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are InvocationRead (12 properties), ActionRead (9 properties), ActionSummary (8 properties), EffectRead (7 properties). Each schema is shown below with its type and property counts.

EffectSummary
object
Per-effect descriptor for the company-scoped Actions panel: enough to render the entity chip + kind badge for every effect without a follow-up fetch. The front…
3 properties 3 required
ActionStatus
string
ActionSummary
object
8 properties 8 required
PrincipalKind
string
What an actiongrant points at.
ActionKind
string
Which ontology row operation an Action drives.
ActionRead
object
9 properties 9 required
GuardIn
object
3 properties 3 required
InvocationResult
string
SourceKind
string
Where a field-write's value comes from.
GrantIn
object
3 properties 1 required
ActionCreate
object
6 properties 2 required
ParameterIn
object
5 properties 1 required
ActionInvokeRequest
object
2 properties
EffectRead
object
7 properties 7 required
InvocationRead
object
One audit-trail row for the per-entity History timeline. Includes the invoking Action's display fields; invokedby is a profile UUID that the frontend maps to a…
12 properties 6 required
InvocationListResponse
object
2 properties 2 required
GrantRead
object
3 properties 1 required
FieldWriteIn
object
4 properties 2 required
RunnableActionRead
object
4 properties 4 required
EffectIn
object
One effect within an ActionCreate payload. Exactly one effect must have isanchor=True. The anchor has relationshipid=None; every secondary effect must supply a…
6 properties 2 required
InvocationSource
string
ValidationError
object
5 properties 3 required
FieldWriteRead
object
4 properties 2 required
HTTPValidationError
object
1 property
ActionUpdate
object
6 properties
GuardRead
object
3 properties 3 required
ParameterRead
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netter-actions-api-openapi.yml Raw ↑

Other APIs Netter publishes across the network.

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 automations 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
#actions
← Back to N APIs
API Details
ID
netter:netter-actions-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