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 Custom Awards API

The Custom Awards API from Nectar — 2 operation(s) for custom awards.

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

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

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

2 operations 2 paths 7 schemas 1 GET1 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 Custom Awards API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 2

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

Custom Awards 2
GET
/v1/custom-awards
Gets custom awards
3 params → 200400401403404429500501
POST
/v1/custom-awards/send
Sends a custom award to recipients
body → 200400401403404429500501

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CustomAwardsBody (5 properties), Links (2 properties), PageInfo (1 property), CustomAwardsResponse (1 property). Each schema is shown below with its type and property counts.

CustomAwardsBody
object
Request body for sending custom awards. Either recipientUuids, recipientEmails, or both must be provided.
5 properties 1 required
Response
object
1 property
FailedResponse
Links
object
2 properties
CustomAwardsResponse
object
1 property
SuccessfulResponse
PageInfo
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nectar-hr-custom-awards-api-openapi.yml Raw ↑

Other APIs Nectar publishes across the network.

Nectar Analytics API
Nectar Flows API
Nectar Health API
Nectar Recognition API
Nectar Users API