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

Nectar Flows API

The Flows API from Nectar — 1 operation(s) for flows.

Nectar Flows API is one of 6 APIs that Nectar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.0.0, at version 0.1.0.

Requests are made against a single base URL, https://api.nectarhr.com.

1 operations 1 paths 6 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1.0
Base URL
https://api.nectarhr.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nectar Flows API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Flows 1
POST
/v1/flows/trigger/{triggerId}
Trigger a Flow for specified users
1 param body → 200400401403404429500501

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Links (2 properties), FlowsTriggerBody (2 properties), FlowsTriggerResponse (1 property), Response (1 property). Each schema is shown below with its type and property counts.

Response
object
1 property
FlowsTriggerBody
object
Request body for triggering a Flow. Provide either emails or userIds.
2 properties
FlowsTriggerResponse
object
1 property
FailedResponse
Links
object
2 properties
SuccessfulResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nectar-hr-flows-api-openapi.yml Raw ↑

Other APIs Nectar publishes across the network.

Nectar Analytics API
Nectar Custom Awards API
Nectar Health API
Nectar Recognition API
Nectar Users API