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

The Employers API from Nayya — 3 operation(s) for employers.

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

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

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

6 operations 3 paths 4 schemas 1 DELETE3 GET1 PATCH1 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 Employers 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 6

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

Employers 6
POST
/employers
Create an Employer
create-employer 1 param body → 201400403404409422500
GET
/employers
Get all Employers
list-employers 6 params → 200403404422500
GET
/employers/{employerId}/is-ready
Check if an Employer is ready
check-employer-is-ready 2 params → 200400404500
PATCH
/employers/{employerId}
Update an Employer
update-employer 2 params body → 200400403404409422500
DELETE
/employers/{employerId}
Delete an Employer
delete-employer 2 params → 204400403404409500
GET
/employers/{employerId}
Get an Employer by ID
get-employer-by-id 2 params → 200403404500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are EmployerResponseDto (16 properties), CreateEmployerDto (14 properties), UpdateEmployerDto (12 properties), ListEmployersDto (4 properties). Each schema is shown below with its type and property counts.

ListEmployersDto
object
4 properties 4 required
CreateEmployerDto
object
14 properties 1 required
EmployerResponseDto
object
16 properties 16 required
UpdateEmployerDto
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nayya-employers-api-openapi.yml Raw ↑

Other APIs Nayya publishes across the network.

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