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

Nayya Benefits API

The Benefits API from Nayya — 4 operation(s) for benefits.

Nayya Benefits API is one of 11 APIs that Nayya publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Benefits. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 3.0.0, at version 0.1.

Requests are made against 2 base URLs: https://integrate.nayya.com/accounts, https://integrate.partners.nayya.com/accounts.

7 operations 4 paths 19 schemas 2 DELETE3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.1
Base URL
https://integrate.nayya.com/accounts
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nayya Benefits API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — JWT token

Paths & Operations 7

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

Benefits 7
GET
/employers/{employerId}/benefits/{benefitId}
Get a Benefit by ID
get-benefit-by-id 3 params → 200403404429500
DELETE
/employers/{employerId}/benefits/{benefitId}
Delete a Benefit by ID
delete-benefit-by-id 3 params → 204403404429500
GET
/employers/{employerId}/benefits
List Benefits for Employer
list-benefits-for-employer 4 params → 200403429500
POST
/employers/{employerId}/benefits
Create or Update a Benefit
create-or-update-benefit 2 params body → 201403422429500
GET
/employers/{employerId}/benefits/employees/{employeeId}/enrolled-benefits
List Enrolled Benefits for Employee
list-enrolled-benefits-for-employee 5 params → 200403429500
POST
/employers/{employerId}/benefits/{benefitId}/benefit-dependencies
Add Benefit Dependencies to Benefit
add-benefit-dependencies-to-benefit 3 params body → 201403404422429500
DELETE
/employers/{employerId}/benefits/{benefitId}/benefit-dependencies
Delete Benefit Dependencies from Benefit
delete-benefit-dependencies-from-benefit 3 params → 204403404429500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are BenefitResponseDto (18 properties), CreateOrUpdateChooseBenefitRequestDto (14 properties), TierResponseDto (7 properties), FeatureItemResponseDto (7 properties). Each schema is shown below with its type and property counts.

PaginatedBenefitsResponseDto
object
4 properties 4 required
BenefitDependencyResponseDto
object
6 properties 4 required
FeatureItemResponseDto
object
7 properties 3 required
NayyaRulePropertiesDto
object
2 properties 2 required
CreateFeatureRequestDto
object
5 properties 2 required
CreateRuleFromTemplateDTO
object
3 properties
CreateTierRequestDto
object
4 properties 3 required
AddBenefitDependencyRequestDto
object
1 property 1 required
CreateBenefitDependencyDto
object
3 properties 1 required
FeatureResponseDto
object
7 properties 6 required
ThresholdItemResponseDto
object
6 properties 3 required
InputValuesItem
object
ThresholdResponseDto
object
6 properties 6 required
CreateEntityRuleRequestDto
object
3 properties
TierResponseDto
object
7 properties 6 required
BenefitResponseDto
object
18 properties 9 required
LabelResponseDto
object
5 properties 5 required
CreateThresholdRequestDto
object
4 properties 2 required
CreateOrUpdateChooseBenefitRequestDto
object
14 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nayya-benefits-api-openapi.yml Raw ↑

Other APIs Nayya publishes across the network.

Nayya Carriers API
Nayya Connections API
Nayya Dependents API
Nayya Employees API
Nayya Employers API
Nayya Enrollments API
Nayya Recommendations API
Nayya Rule Templates API
Nayya Snapshots API
Nayya Token API