Noyo Group Configuration API
The Group Configuration API from Noyo — 20 operation(s) for group configuration.
The Group Configuration API from Noyo — 20 operation(s) for group configuration.
openapi: 3.0.1
info:
description: APIs to manage and consume information about Carriers
title: Noyo Carrier Carrier Mapped Field Group Configuration API
version: 1.0.0
servers: []
tags:
- name: Group Configuration
paths:
/api/v1/dependents/{dependent_id}:
x-summary: Get Single Dependent
get:
description: Returns the latest version of a single dependent based on the ID provided.
operationId: getDependent
parameters:
- description: The unique identifier of the dependent you would like to view
in: path
name: dependent_id
required: true
schema:
example: fd62665c-0846-4e9d-bd29-80779b5f685c
format: uuid
type: string
responses:
'200':
content:
application/json:
example:
created: 1557512389
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: fd62665c-0846-4e9d-bd29-80779b5f685c
modified: 1547412389
person:
contact:
email_address: diane@testemail.com
email_address_type: home
home_phone: '+12065551234'
date_of_birth: '1982-01-02'
first_name: Diane
home_address:
city: San Francisco
county: San Francisco
state: CA
street_one: 1234 Home Ave
zip_code: '94107'
last_name: Johnson
marital_status: married
sex: F
ssn: '987654321'
relationship: spouse
version: 669fbe16-9960-4069-91aa-832ada3f4e42
schema:
$ref: '#/components/schemas/DependentResult'
description: Successful Response - Returns a single Dependent
summary: Get a single Dependent
tags:
- Group Configuration
/api/v1/employees:
x-summary: Create New Employee
get:
description: Filter employees across all groups in your organization.
operationId: getEmployeeList
parameters:
- description: The max size of each page of results
in: query
name: page_size
required: false
schema:
type: integer
- description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
in: query
name: offset
required: false
schema:
type: integer
- description: The employee first name for which you would like to filter
in: query
name: first_name
required: false
schema:
type: string
- description: The employee last name for which you would like to filter
in: query
name: last_name
required: false
schema:
type: string
- description: The employee's name for which you would like to filter
in: query
name: name
required: false
schema:
type: string
- description: The ISO-8601 (YYYY-MM-DD) employee date of birth for which you would like to filter
in: query
name: date_of_birth
required: false
schema:
type: string
- description: Status of the employees employment
in: query
name: employment_status
required: false
schema:
type: string
- description: Filter employees by Person ID
in: query
name: person_id
required: false
schema:
type: string
- description: Filter employees by Group ID
in: query
name: group_id
required: false
schema:
example: 4613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 20
total_records: 1
response:
- employment:
employment_dates:
full_time_start: '2015-01-01'
hire_date: '2014-12-10'
employment_status: full-time
hours_worked: 50
occupation: Senior Analyst
salary:
amount: 55000
type: salary
unit: annual
work_state: CA
group_id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
location_id: bd957820-4652-4ee7-8a3a-6413df21e28d
person:
contact:
email_address: david@testemail.com
email_address_type: home
home_phone: '+12065551234'
preferred_method: email
work_phone: '+12065559876'
date_of_birth: '1981-06-22'
first_name: David
home_address:
city: San Francisco
county: San Francisco
state: CA
street_one: 1234 Home Ave
zip_code: '94107'
last_name: Johnson
marital_status: single
sex: M
ssn: '123456789'
version: 6260146a-3486-4c3d-b2a6-fcd3f8c84043
schema:
$ref: '#/components/schemas/PaginatedEmployeeResult'
description: Successful Response - Returns all matching Employees
summary: Filter all employees
tags:
- Group Configuration
post:
description: Create a new employee for a group.
operationId: createEmployee
requestBody:
content:
application/json:
examples:
success:
value:
classifications:
BranchName: HQ
employment:
employment_dates:
full_time_start: '2015-01-01'
hire_date: '2014-12-10'
employment_status: full-time
hours_worked: 50
occupation: Senior Analyst
salary:
amount: 55000
type: salary
unit: annual
work_state: CA
group_id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
location_id: bd957820-4652-4ee7-8a3a-6413df21e28d
person:
contact:
email_address: david@testemail.com
email_address_type: home
home_phone: '+12065551234'
preferred_method: email
work_phone: '+12065559876'
date_of_birth: '1981-06-22'
first_name: David
home_address:
city: San Francisco
county: San Francisco
state: CA
street_one: 1234 Home Ave
zip_code: '94107'
last_name: Johnson
marital_status: married
sex: M
ssn: '123456789'
schema:
$ref: '#/components/schemas/EmployeeCreateRequest'
required: true
responses:
'201':
content:
application/json:
example:
classifications:
BranchName: HQ
created: 1626281253
employment:
employment_dates:
full_time_start: '2015-01-01'
hire_date: '2014-12-10'
employment_status: full-time
hours_worked: 50
occupation: Senior Analyst
salary:
amount: 55000
type: salary
unit: annual
group_id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
location_id: bd957820-4652-4ee7-8a3a-6413df21e28d
modified: 1626281253
person:
contact:
email_address: david@testemail.com
email_address_type: home
home_phone: '+12065551234'
preferred_method: email
work_phone: '+12065559876'
date_of_birth: '1981-06-22'
first_name: David
home_address:
city: San Francisco
county: San Francisco
state: CA
street_one: 1234 Home Ave
zip_code: '94107'
last_name: Johnson
marital_status: married
sex: M
ssn: '123456789'
version: 6260146a-3486-4c3d-b2a6-fcd3f8c84043
schema:
$ref: '#/components/schemas/EmployeeResult'
description: Successful Response - Returns the new Employee
summary: Create a new Employee
tags:
- Group Configuration
/api/v1/employees/{employee_id}:
x-summary: Get Single Employee
get:
description: Returns the latest version of a single employee based on the ID provided.
operationId: getEmployee
parameters:
- description: The unique identifier of the employee you would like to view
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
responses:
'200':
content:
application/json:
example:
employment:
employment_dates:
full_time_start: '2015-01-01'
hire_date: '2014-12-10'
employment_status: full-time
hours_worked: 50
occupation: Senior Analyst
salary:
amount: 55000
type: salary
unit: annual
work_state: CA
group_id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
location_id: bd957820-4652-4ee7-8a3a-6413df21e28d
person:
contact:
email_address: david@testemail.com
email_address_type: home
home_phone: '+12065551234'
preferred_method: email
work_phone: '+12065559876'
date_of_birth: '1981-06-22'
first_name: David
home_address:
city: San Francisco
county: San Francisco
state: CA
street_one: 1234 Home Ave
zip_code: '94107'
last_name: Johnson
marital_status: ''
sex: M
ssn: '123456789'
version: 6260146a-3486-4c3d-b2a6-fcd3f8c84043
schema:
$ref: '#/components/schemas/EmployeeResult'
description: Successful Response - Returns a single Employee
summary: Get a single Employee
tags:
- Group Configuration
/api/v1/employees/{employee_id}/dependents:
x-summary: Dependents
get:
description: Returns a list of all dependents for a given employee.
operationId: getDependentList
parameters:
- description: The unique identifier of the employee for which you would like to view dependents
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
- description: The max size of each page of results
in: query
name: page_size
required: false
schema:
type: integer
- description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
in: query
name: offset
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 20
total_records: 1
response:
- created: 1557512389
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: fd62665c-0846-4e9d-bd29-80779b5f685c
modified: 1547412389
person:
contact:
email_address: diane@testemail.com
email_address_type: home
home_phone: '+12065551234'
date_of_birth: '1982-01-02'
first_name: Diane
home_address:
city: San Francisco
county: San Francisco
state: CA
street_one: 1234 Home Ave
zip_code: '94107'
last_name: Johnson
marital_status: ''
sex: F
ssn: '987654321'
relationship: spouse
version: 669fbe16-9960-4069-91aa-832ada3f4e42
schema:
$ref: '#/components/schemas/PaginatedDependentResult'
description: Successful Response - Returns all matching Dependents
summary: List All Dependents
tags:
- Group Configuration
post:
description: Create a new dependent for an employee.
operationId: createDependent
parameters:
- description: The unique identifier of the employee the dependent belongs to
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
value:
person:
contact:
email_address: jamie@testemail.com
email_address_type: home
home_phone: '+12065551234'
date_of_birth: '2000-01-02'
first_name: Jamie
home_address:
city: San Francisco
county: San Francisco
state: CA
street_one: 1234 Home Ave
zip_code: '94107'
last_name: Johnson
marital_status: single
sex: F
ssn: '384032999'
relationship: child
schema:
$ref: '#/components/schemas/DependentCreateRequest'
required: true
responses:
'201':
content:
application/json:
example:
created: 1626281253
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: fd62665c-0846-4e9d-bd29-80779b5f685c
modified: 1626281253
person:
contact:
email_address: jamie@testemail.com
email_address_type: home
home_phone: '+12065551234'
date_of_birth: '2000-01-02'
first_name: Jamie
home_address:
city: San Francisco
county: San Francisco
state: CA
street_one: 1234 Home Ave
zip_code: '94107'
last_name: Johnson
marital_status: single
sex: F
ssn: '384032999'
relationship: child
version: 669fbe16-9960-4069-91aa-832ada3f4e42
schema:
$ref: '#/components/schemas/DependentResult'
description: Successful Response - Returns the new Dependent
summary: Create a new Dependent
tags:
- Group Configuration
/api/v1/employees/{employee_id}/dependents/{dependent_id}:
x-summary: Get Single Dependent of Employee
get:
description: Returns the latest version of a single dependent of an employee based on the ID provided.
operationId: getEmployeeDependent
parameters:
- description: The unique identifier of the employee the dependent belongs to
in: path
name: employee_id
required: true
schema:
example: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
format: uuid
type: string
- description: The unique identifier of the dependent you would like to view
in: path
name: dependent_id
required: true
schema:
example: fd62665c-0846-4e9d-bd29-80779b5f685c
format: uuid
type: string
responses:
'200':
content:
application/json:
example:
created: 1557512389
employee_id: 30b74a44-d5b1-4123-a7a4-6d3aec251ba4
id: fd62665c-0846-4e9d-bd29-80779b5f685c
modified: 1547412389
person:
contact:
email_address: diane@testemail.com
email_address_type: home
home_phone: '+12065551234'
date_of_birth: '1982-01-02'
first_name: Diane
home_address:
city: San Francisco
county: San Francisco
state: CA
street_one: 1234 Home Ave
zip_code: '94107'
last_name: Johnson
marital_status: ''
sex: F
ssn: '987654321'
relationship: spouse
version: 669fbe16-9960-4069-91aa-832ada3f4e42
schema:
$ref: '#/components/schemas/DependentResult'
description: Successful Response - Returns a single Dependent
summary: Get a single Dependent of Employee
tags:
- Group Configuration
/api/v1/groups:
x-summary: Create Group
get:
description: 'Returns a list of all groups in the current user organization.
If you would like to search the groups list, you can use the company query param. It allows searches based on the group''s name or dba_name values.
'
operationId: getGroupList
parameters:
- description: The max size of each page of results
in: query
name: page_size
required: false
schema:
type: integer
- description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
in: query
name: offset
required: false
schema:
type: integer
- description: This query param searches groups by name or dba_name values
in: query
name: company
required: false
schema:
type: string
- description: Comma-separated list of requested UUID group IDs
in: query
name: group_ids
required: false
schema:
type: string
- description: Used for filtering for a carrier-specific group ID. Filter by the Noyo carrier ID. Must be used with carrier_group_id
in: query
name: carrier_id
required: false
schema:
type: string
- description: Used for filtering for a carrier-specific group ID. Must be used with carrier_id
in: query
name: carrier_group_id
required: false
schema:
type: string
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 20
total_records: 1
response:
- created: 1557512389
dba_name: Test Corp
federal_ein: '112222222'
id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
modified: 1543215342
name: Test Company
organization_id: d61fa455-adf4-4dc4-8c57-6d779ba9475e
sic_code: '7371'
version: 6b72d72d-cc99-4df6-8152-7183e824c80c
schema:
$ref: '#/components/schemas/PaginatedGroupResult'
description: Successful Response - Returns all matching Groups
summary: Get a list of all Groups
tags:
- Group Configuration
post:
description: Create a new group.
operationId: createGroup
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GroupCreateRequest'
required: true
responses:
'201':
content:
application/json:
example:
created: 1557512389
dba_name: Test Corp
federal_ein: '112222222'
id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
modified: 1557512389
name: Test Company
organization_id: d61fa455-adf4-4dc4-8c57-6d779ba9475e
sic_code: '7371'
version: 6b72d72d-cc99-4df6-8152-7183e824c80c
schema:
$ref: '#/components/schemas/GroupResult'
description: Successful Response - Returns the new Group
summary: Create a new Group
tags:
- Group Configuration
/api/v1/groups/{group_id}:
x-summary: Get Single Group
get:
description: Returns the latest version of a single group based on the ID provided.
operationId: getGroup
parameters:
- description: The unique identifier of the group to be retrieved
in: path
name: group_id
required: true
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
responses:
'200':
content:
application/json:
example:
created: 1557512389
dba_name: Test Corp
federal_ein: '112222222'
id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
modified: 1543215342
name: Test Company
organization_id: d61fa455-adf4-4dc4-8c57-6d779ba9475e
sic_code: '7371'
version: 6b72d72d-cc99-4df6-8152-7183e824c80c
schema:
$ref: '#/components/schemas/GroupResult'
description: Successful Response - Returns a single Group
summary: Get a single Group
tags:
- Group Configuration
/api/v1/groups/{group_id}/carrier_configurations:
x-summary: Get Group Carrier Configurations
get:
description: Certain carriers have custom data for each group such as billing group information. This endpoint can be used to retrieve carrier-specific configuration data.
operationId: getCarrierConfigurationByGroupList
parameters:
- description: The unique identifier of the group for which you would like to view carrier configurations.
in: path
name: group_id
required: true
schema:
example: 2705bb9f-3c90-4400-a4e7-0bc9d48e677c
format: uuid
type: string
- description: The relative date on which to view the state of the record
in: query
name: effective_date
required: false
schema:
type: string
responses:
'200':
content:
application/json:
example:
- carrier_group_id: '9100084'
carrier_id: d0003042-eaae-4491-b219-4825456a3d16
configuration:
bill_groups:
- bill_group_description: All Members
bill_group_number: 10001
bill_group_status: open
member_groups:
- member_group_key: 2613038
member_group_name: MEMBERS A
member_group_status: open
- member_group_key: 2613037
member_group_name: MEMBERS B
member_group_status: open
policy_number: '9100084'
group_id: 2705bb9f-3c90-4400-a4e7-0bc9d48e677c
schema:
items:
$ref: '#/components/schemas/PublicGroupCarrierConfigurationResult'
type: array
description: Successful Response - Returns all matching Carrier Configurations
summary: Get a list of all Carrier Configurations by Group
tags:
- Group Configuration
/api/v1/groups/{group_id}/carrier_configurations/{group_carrier_configuration_id}/{version}:
x-summary: Edit Group Carrier Configurations
put:
description: Edit a group carrier configuration
operationId: editGroupConnectionConfigurationPublic
parameters:
- description: The unique identifier of the related group
in: path
name: group_id
required: true
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
- description: The unique identifier of the group carrier configuration
in: path
name: group_carrier_configuration_id
required: true
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
- description: The unique version of the related group carrier configuration
in: path
name: version
required: true
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
requestBody:
content:
application/json:
examples:
success:
value:
connection_configuration:
data_exchange:
enrollments:
from_carrier:
enabled: true
to_carrier:
default_method: api
enabled: true
schema:
$ref: '#/components/schemas/PublicGroupCarrierConfigurationEditRequest'
required: true
responses:
'201':
content:
application/json:
example:
carrier_group_id: '9100084'
carrier_id: 9a0a7437-4097-4251-9e71-85384c0eb1c9
configuration:
bill_groups:
- bill_group_description: All Members
bill_group_number: 10001
bill_group_status: open
member_groups:
- member_group_key: 2613038
member_group_name: MEMBERS A
member_group_status: open
- member_group_key: 2613037
member_group_name: MEMBERS B
member_group_status: open
policy_number: '9100084'
connection_configuration:
data_exchange:
enrollments:
from_carrier:
enabled: true
to_carrier:
default_method: api
enabled: true
group_id: 2c4d5515-6bf8-4f8c-821a-9c56374198b2
id: 744d1906-feeb-4234-b49d-1d9cb26b7406
version: 7a2b0437-4027-4251-9e71-85384c0eb1c9
schema:
$ref: '#/components/schemas/PublicGroupCarrierConfigurationResult'
description: Successful Response - Returns the new group carrier configuration
summary: group connection configuration
tags:
- Group Configuration
/api/v1/groups/{group_id}/contacts:
x-summary: Get/Create Contacts
get:
description: Returns a list of all group contacts for a given group.
operationId: getContactList
parameters:
- description: The unique identifier of the group for which you would like to view contacts
in: path
name: group_id
required: true
schema:
example: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
format: uuid
type: string
- description: The max size of each page of results
in: query
name: page_size
required: false
schema:
type: integer
- description: The integer offset at which to start the page. Possible values are 0 to total_records - 1
in: query
name: offset
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
example:
meta:
offset: 0
page_num: 1
page_size: 20
total_records: 2
response:
- created: 1557512389
email: davidsmith@testcorp.com
first_name: David
group_id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
id: c2f5489d-36d1-4fb0-bf9f-105ad5dd0b3e
last_name: Smith
modified: 1543215342
phone_number: '+14255551234'
primary_contact: true
title: Chief People Officer
types:
- company
- billing
version: 6ba43c6e-69f2-435f-a126-8595a798eb52
- created: 1557512389
email: carolinejohnson@testcorp.com
first_name: Caroline
group_id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
id: 7e3c1f14-e7e7-42b8-81d8-3fcd7bd7d418
last_name: Johnson
modified: 1543215342
phone_number: '+14255551234'
primary_contact: false
title: VP of Human Resources
types:
- executive
version: 88bfbe28-7f8b-4497-a50b-932ee3387b68
schema:
$ref: '#/components/schemas/PaginatedContactResult'
description: Successful Response - Returns all matching Group Contacts
summary: Get a list of all Group Contacts
tags:
- Group Configuration
post:
description: Create a new contact for a group.
operationId: createContact
parameters:
- in: path
name: group_id
required: true
schema:
format: uuid
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactCreateRequest'
required: true
responses:
'201':
content:
application/json:
example:
created: 1626281253
email: davidsmith@testcorp.com
first_name: David
group_id: 2613a221-d3c8-4c8a-86d5-e7e885fd1da9
id: c2f5489d-36d1-4fb0-bf9f-105ad5dd0b3e
last_name: Smith
modified: 1626281253
phone_number: '+14255551234'
primary_contact: true
title: Chief People Officer
types:
- company
- billing
version: 6ba43c6e-69f2-435f-a126-8595a798eb52
schema:
$ref: '#/components/schemas/ContactResult'
description: Successful Response - Returns the new Group Contact
summary: Create a new Group Contact
tags:
- Group Configuration
/api/v1/groups/{group_id}/contacts/{contact_id}:
# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/noyo/refs/heads/main/openapi/noyo-group-configuration-api-openapi.yml