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

Noyo Groups API

The Groups API from Noyo — 7 operation(s) for groups.

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

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

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

7 operations 7 paths 58 schemas 7 GET

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 7

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

Groups 7
GET
/ui/v1/groups
Get a list of all Groups
uiGetGroupList 9 params → 200
GET
/ui/v1/groups/{group_id}
Get a single Group
uiGetGroup 1 param → 200
GET
/ui/v1/groups/{group_id}/carriers
Get a list of all Carriers for a Group
uiGetGroupCarriers 2 params → 200
GET
/ui/v1/groups/{group_id}/group_plans
Get a list of all Group Plans
uiGetGroupPlansList 3 params → 200
GET
/ui/v1/groups/{group_id}/mappable_fields
Get a list of all Mappable Fields for the Group and Carrier
uiGetGroupMappableFields 5 params → 200
GET
/ui/v1/groups/{group_id}/platform_group_structure
Get Platform Group Structure
UIGroupPlatformGroupStructureResult 1 param → 200
GET
/ui/v1/groups/{group_id}/platform_mapping
Get Platform Mapping - Platform Account Structure and Group Mapping
uiGetGroupPlatformMapping 3 params → 200

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are GroupDentalPlanPublicResult (22 properties), GroupMedicalPlanPublicResult (21 properties), GroupLifePlanPublicResult (21 properties), GroupVisionPlanPublicResult (20 properties). Each schema is shown below with its type and property counts.

EnrollmentsFromCarrier
object
1 property
GroupMedicalPlanPublicResult
object
21 properties 13 required
GroupLTDPlanPublicResult
object
19 properties 15 required
Address
object
6 properties 4 required
Meta
object
4 properties 3 required
UIGroupMappableFieldsResult
object
2 properties 2 required
PaginatedUIGroupPlanResult
object
2 properties 2 required
PublicGroupCarrierConnectionConfigurationResult
object
2 properties
PlatformAccountStructureAccountStructure
object
2 properties
PublicGroupCarrierConfigurationResult
object
7 properties 5 required
GroupVisionPlanPublicResult
object
20 properties 14 required
UIGroupResultWithCustomIdentifiers
object
13 properties 6 required
Enrollments
object
2 properties
GroupStructure
object
2 properties
GroupMappingResult
object
9 properties 7 required
GroupLifePlanPublicResult
object
21 properties 15 required
GroupHealthFundPlanPublicResult
object
20 properties 15 required
UIMappedField
object
7 properties 5 required
PlatformStructureTemporalPlan
object
3 properties
GroupPlanCOBRARules
object
1 property
GroupAccidentPlanBenefitsSnapshot
object
4 properties
PaginatedUIGroupResult
object
2 properties 2 required
UIPlans
object
14 properties
GroupVisionPlanBenefitsSnapshot
object
1 property
GroupPlanDependentChildAgeLimit
object
3 properties 3 required
PlatformStructurePlan
object
6 properties 2 required
PlatformAccountStructureResult
object
6 properties 6 required
GroupAccidentPlanPublicResult
object
19 properties 14 required
PlatformAccountStructureAccountStructureField
object
3 properties 3 required
GroupPharmacyPlanPublicResult
object
20 properties 14 required
GroupEnrollmentPublicResult
object
13 properties 8 required
PaginatedUIGroupMappableFieldsResult
object
2 properties 2 required
GroupADDPlanPublicResult
object
19 properties 15 required
GroupLTDPlanBenefitsSnapshot
object
11 properties
EnrollmentErrors
object
2 properties
GroupLifePlanBenefitsSnapshot
object
10 properties
GroupCriticalIllnessPlanBenefitsSnapshot
object
5 properties
GroupSTDPlanBenefitsSnapshot
object
9 properties
LocationResult
object
7 properties 7 required
PlatformAccountStructureAccountStructurePlan
object
14 properties
UIGroupPlanResult
object
5 properties 5 required
GroupDentalPlanPublicResult
object
22 properties 14 required
GroupCriticalIllnessPlanPublicResult
object
20 properties 15 required
UIGroupParentResult
object
5 properties 2 required
GroupDentalPlanBenefitsSnapshot
object
1 property
GroupWellnessPlanBenefitsSnapshot
object
1 property
DataExchange
object
3 properties
PlatformStructure
object
1 property
GroupPlanBenefitDurationPeriod
object
2 properties 2 required
GroupWellnessPlanPublicResult
object
20 properties 14 required
GroupCancerPlanPublicResult
object
18 properties 14 required
GroupPlanDisabilityEliminationPeriod
object
2 properties 2 required
GroupSTDPlanPublicResult
object
19 properties 15 required
UIGroupPlatformGroupStructureResult
object
7 properties 6 required
GroupADDPlanBenefitsSnapshot
object
1 property
EnrollmentsToCarrier
object
2 properties
UIGroupPlatformMappingResult
object
3 properties 1 required
GroupHospitalIndemnityPlanPublicResult
object
18 properties 14 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

noyo-groups-api-openapi.yml Raw ↑

Other APIs Noyo publishes across the network.

Noyo Carrier Mapped Field API
Noyo Carrier Sync API
Noyo Carriers API
Noyo Cases API
Noyo Condition API
Noyo Connection Eligibility API
Noyo Dependent API
Noyo Differences API
Noyo Discrepancies API
Noyo Eligibility Rules API
Noyo Employee API
Noyo Export API