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

The Users API from Nectar — 2 operation(s) for users.

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

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

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

3 operations 2 paths 10 schemas 2 GET1 PUT

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

Paths & Operations 3

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

Users 3
GET
/v1/users/{userId}
Gets general information about a specific user
2 params → 200400401403404429500501
GET
/v1/users
Gets a paginated list of users within the company
7 params → 200400401403404429500501
PUT
/v1/users
Upsert up to 50 users at a time based on nectarid (recommended), email, or employeeid
3 params body → 200400401403404429500501

Schemas 10

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

UserUpsertRequestBody
array
Response
object
1 property
BaseUser
UserDetailsResponse
object
1 property
ExpandedUser
FailedResponse
Links
object
2 properties
UserUpsertBody
object
19 properties
SuccessfulResponse
UsersResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Nectar publishes across the network.

Nectar Analytics API
Nectar Custom Awards API
Nectar Flows API
Nectar Health API
Nectar Recognition API