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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Noyo

Noyo Group Configuration API

The Group Configuration API from Noyo — 20 operation(s) for group configuration.

Documentation Provider Profile APIs.io OpenAPI GitHub

Noyo Group Configuration API is one of 64 APIs that Noyo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 24 operations across 20 paths, and defines 50 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against the base URL https://fulfillment.noyo.com.

24 operations 20 paths 50 schemas 17 GET4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://fulfillment.noyo.com
Resource Areas
1

Paths & Operations 24

Across 20 paths, the API surfaces 24 operations — 17 GET, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Group Configuration 24
GET
/api/v1/dependents/{dependent_id}
Get a single Dependent
getDependent 1 param → 200
GET
/api/v1/employees
Filter all employees
getEmployeeList 9 params → 200
POST
/api/v1/employees
Create a new Employee
createEmployee body → 201
GET
/api/v1/employees/{employee_id}
Get a single Employee
getEmployee 1 param → 200
GET
/api/v1/employees/{employee_id}/dependents
List All Dependents
getDependentList 3 params → 200
POST
/api/v1/employees/{employee_id}/dependents
Create a new Dependent
createDependent 1 param body → 201
GET
/api/v1/employees/{employee_id}/dependents/{dependent_id}
Get a single Dependent of Employee
getEmployeeDependent 2 params → 200
GET
/api/v1/groups
Get a list of all Groups
getGroupList 6 params → 200
POST
/api/v1/groups
Create a new Group
createGroup body → 201
GET
/api/v1/groups/{group_id}
Get a single Group
getGroup 1 param → 200
GET
/api/v1/groups/{group_id}/carrier_configurations
Get a list of all Carrier Configurations by Group
getCarrierConfigurationByGroupList 2 params → 200
PUT
/api/v1/groups/{group_id}/carrier_configurations/{group_carrier_configuration_id}/{version}
group connection configuration
editGroupConnectionConfigurationPublic 3 params body → 201
GET
/api/v1/groups/{group_id}/contacts
Get a list of all Group Contacts
getContactList 3 params → 200
POST
/api/v1/groups/{group_id}/contacts
Create a new Group Contact
createContact 1 param body → 201
GET
/api/v1/groups/{group_id}/contacts/{contact_id}
Get a single Group Contact
getContact 2 params → 200
PUT
/api/v1/groups/{group_id}/contacts/{contact_id}/{version}
Edit an existing Group Contact
editContact 3 params body → 200
GET
/api/v1/groups/{group_id}/employees
Filter employees in a group
getGroupEmployeeList 8 params → 200
GET
/api/v1/groups/{group_id}/employees/{employee_id}/dependents
List All Group Employee Dependents
getGroupEmployeeDependentList 4 params → 200
GET
/api/v1/groups/{group_id}/locations
Get a list of all Group Locations
getLocationList 3 params → 200
GET
/api/v1/groups/{group_id}/locations/{location_id}
Get a single Group Location
getLocation 2 params → 200
PUT
/api/v1/groups/{group_id}/{version}
Edit an existing Group
editGroup 2 params body → 200
GET
/ui/v1/employees
Get a list of all Employees
uiGetEmployeeList 8 params → 200
GET
/ui/v1/employees/{employee_id}
Get a single Employee
uiGetEmployee 1 param → 200
GET
/ui/v1/groups/{group_id}/employees
Get a list of all Employees by Group
uiGetGroupEmployeeList 7 params → 200

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are IndividualEnrollmentResult (16 properties), CreatePersonRequest (13 properties), ContactResult (13 properties), Person (13 properties). Each schema is shown below with its type and property counts.

CreatePersonRequest
object
13 properties 5 required
EnrollmentsFromCarrier
object
1 property
IndividualEnrollmentResult
object
16 properties 12 required
Address
object
6 properties 4 required
Meta
object
4 properties 3 required
PaginatedContactResult
object
2 properties 2 required
PublicGroupCarrierConnectionConfigurationResult
object
2 properties
COBRADetails
object
4 properties 1 required
PaginatedLocationResult
object
2 properties 2 required
PublicGroupCarrierConfigurationResult
object
7 properties 5 required
DependentCreateRequest
object
2 properties 2 required
UIEmployeeParentResult
object
4 properties 2 required
PublicGroupCarrierConnectionConfigurationEdit
object
2 properties
Enrollments
object
2 properties
GroupStructure
object
2 properties
EmploymentResult
object
5 properties 3 required
PersonAmericanIndian
object
2 properties
EmployeeCreateRequest
object
5 properties 3 required
PersonDisability
object
3 properties
DependentResult
object
8 properties 7 required
PersonWithoutSSN
object
12 properties 5 required
GroupEditRequest
object
4 properties
PaginatedEmployeeResult
object
2 properties 2 required
GroupResult
object
9 properties 5 required
ContactEditRequest
object
8 properties
PersonContact
object
7 properties
PersonDetails
object
5 properties
Salary
object
3 properties
PublicGroupCarrierConfigurationEditRequest
object
1 property
Person
object
13 properties 5 required
EnrollmentsToCarrier
object
2 properties
ContactResult
object
13 properties 6 required
Employment
object
5 properties 3 required
GroupCreateRequest
object
5 properties 1 required
EmploymentDates
object
5 properties 1 required
EmploymentDatesResult
object
5 properties
EnrollmentErrors
object
2 properties
LocationResult
object
7 properties 7 required
PersonTobacco
object
4 properties
PaginatedDependentResult
object
2 properties 2 required
ContactCreateRequest
object
8 properties 4 required
DependentResultWithoutSSN
object
8 properties 7 required
EmployeeResult
object
10 properties 7 required
DataExchange
object
3 properties
PrimaryCareProvider
object
9 properties 2 required
PCPDetails
object
1 property 1 required
PaginatedUIEmployeeResult
object
2 properties 2 required
PaginatedGroupResult
object
2 properties 2 required
IndividualEnrollmentCOBRAEnrollment
object
2 properties
EmployeeResultWithoutSSN
object
10 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

noyo-group-configuration-api-openapi.yml Raw ↑

Other APIs Noyo publishes across the network.

Noyo Carrier Mapped Field API
AE Profile APIs.io
Noyo Carrier Sync API
AE Profile APIs.io
Noyo Carriers API
AE Profile APIs.io
Noyo Cases API
AE Profile APIs.io
Noyo Condition API
AE Profile APIs.io
Noyo Connection Eligibility API
AE Profile APIs.io
Noyo Dependent API
AE Profile APIs.io
Noyo Differences API
AE Profile APIs.io
Noyo Discrepancies API
AE Profile APIs.io
Noyo Eligibility Rules API
AE Profile APIs.io
Noyo Employee API
AE Profile APIs.io
Noyo Export API
AE Profile APIs.io
#Group Configuration
← Back to N APIs
API Details
ID
noyo:noyo-group-configuration-api
Base URL
https://fulfillment.noyo.com
Docs
https://docs.noyo.com/api-reference/fulfillment
Provider
Noyo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network