How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Certifyos Group API

APIs for managing group entities

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

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 20 operations across 14 paths, and defines 75 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 6 base URLs: http://localhost:9000, https://api-service.staging.certifyos.com, https://api-service.internal.certifyos.com, https://api-service.test.certifyos.com, https://api-service.demo.certifyos.com, https://api-service.certifyos.com.

20 operations 14 paths 75 schemas 3 GET3 PATCH7 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api-service.certifyos.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Certifyos Group API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (jwt).

  • jwt — JWT Authentication - Provide only the raw token without Bearer prefix

Paths & Operations 20

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

Group 20

APIs for managing group entities

GET
/groups
Find Group by filter criteria with pagination
groupFindMany 8 params → 200401
POST
/groups
Create a new group
groupCreate 2 params body → 201400401403500
PATCH
/groups/locations/{locationId}/networks
Update effective date for all group location network associations
updateGroupLocationNetworkDates 2 params body → 200400404500
POST
/groups/locations/{locationId}/networks
Associate a group location with networks
associateGroupLocationNetworks 2 params body → 201400401403404500
PUT
/groups/locations/{locationId}/networks/terminate
Terminate a group location from networks
terminateGroupLocationFromNetwork 2 params body → 200400401403404500
PUT
/groups/locations/{locationId}/terminate
Terminate a group location
terminateGroupLocation 2 params body → 200400401403404500
PUT
/groups/{groupId}/locations
Update group location details
updateGroupLocations 2 params body → 200400401403404500
POST
/groups/{groupId}/locations
Add new location to group
addGroupLocation 2 params body → 201400401403404500
PUT
/groups/{groupId}/networks
Update group network associations
updateGroupNetworks 2 params body → 200400401403404500
PATCH
/groups/{groupId}/networks/terminate
Terminate group participation in networks
terminateGroupNetworks 2 params body → 200400401403404500
PUT
/groups/{id}
Update a group
groupUpdate 2 params body → 200400401403404500
GET
/groups/{id}
Get a group value by their ID
groupGet 2 params → 200404
POST
/groups/{id}/practitioners
Associate practitioners with a group
associateGroupPractitioners 2 params body → 201400401403404500
GET
/groups/{id}/relationships/all
Get all the relationships of the group
getAllGroupRelationships 2 params → 200401403404500
PUT
/groups/{id}/specialties
Update a group specialty
groupUpdateSpecialty 2 params body → 200400404500
PATCH
/groups/{id}/specialties
Batch add and update group specialties
manageGroupSpecialties 2 params body → 200400500
POST
/groups/{id}/specialties
Add a specialty to a group
groupAddSpecialty 2 params body → 201400404500
POST
/groups/{id}/specialties/terminate
Terminate group specialties from network participation
terminateGroupSpecialties 2 params body → 200400401403404500
POST
/groups/{id}/supporting-documents
Upload a supporting document for a group
createGroupSupportingDocument 2 params body → 201400401403500
PUT
/groups/{sourceType}/{crosswalkId}deprecated
Update a group (Legacy)
groupUpdateLegacy 4 params body → 200400500

Schemas 75

The contract defines 75 schemas that model the data the API accepts and returns. The most detailed are UpdateGroupRequest (26 properties), JsonNode (22 properties), UpdateGroupLocationRequest (15 properties), AddGroupLocationRequest (14 properties). Each schema is shown below with its type and property counts.

TerminateGroupSpecialtyRequest
object
Request to terminate one or more group specialties from network participation. Terminates at group-network association; optionally at group-location and group-…
8 properties 3 required
SpecialtyNotCreatedReason
string
LocationNetwork1
object
Network association for a practitioner at a specific location
2 properties 1 required
LocationService1
object
4 properties 2 required
LocationAddress
object
9 properties 6 required
AccessibilityItem
object
2 properties 2 required
UpdateGroupLocationsRequest
object
2 properties 2 required
SpecialtyAssociationLevel
string
UpdateGroupLocationNetworkDatesRequest
object
1 property 1 required
OfficeHours
object
1 property
GroupLocationNetworkResponse
object
Response for a group location-network association
2 properties
PracticeLimitation
object
3 properties 2 required
GroupCreateResponse
object
2 properties
ApiError1
object
1 property
TerminateGroupLocationFromNetworkResponse
object
Response for terminating a group location from networks
4 properties 4 required
CreateGroupSpecialtyRequest
object
9 properties 2 required
TerminateGroupNetworksResponse
object
Result of terminating a group from one or more networks.
5 properties 5 required
ErrorObject1
object
4 properties
AssociateGroupPractitionersResponse
object
Response for associating practitioners with a group
1 property
TaxInfo
object
6 properties
NetworkAssociationResult
object
Result of a single network association update
3 properties
LocationContact
object
7 properties 2 required
UpdateSpecialtyItem1
object
5 properties 1 required
PagedResponse
object
6 properties
PracticeLimitation1
object
3 properties 2 required
ManageGroupSpecialtiesRequest
object
3 properties
LocationNetwork
object
2 properties 1 required
GroupResponse
object
Complete group information including core data, tenant data, and addresses
14 properties
GroupPractitionerLocationResponse
object
Response for a practitioner-location association
2 properties
AddGroupLocationResponse
object
Response containing all created group location resources and relationships
13 properties
NetworkAssociation
object
Network association information
5 properties 1 required
LocationAddress1
object
9 properties 6 required
TerminateGroupLocationFromNetworkRequest
object
Request to terminate a group location from networks
4 properties 1 required
GroupPractitionerRequest
object
Request to associate a single practitioner with a group
4 properties 1 required
LocationAssociationResult2
object
3 properties
AddGroupLocationRequest
object
Request to add a new location to a group
14 properties 1 required
DayHours
object
3 properties 3 required
ManageGroupSpecialtiesResponse
object
3 properties
TerminateGroupLocationResponse
object
Response for terminating a group location
8 properties 7 required
GroupAddressData
object
Group address information
9 properties
UpdateGroupRequest
object
Request to update an existing group with complete data
26 properties
AssociateGroupLocationNetworksResponse
object
Response for associating a group location with networks
2 properties
NetworkTerminationResult
object
Termination result for a single network
3 properties 2 required
PractitionerNetwork
object
Network association for a practitioner
2 properties 1 required
UpdateGroupSpecialtyRequest
object
13 properties 1 required
DayHours1
object
3 properties 3 required
UpdateGroupNetworksRequest
object
Request to update a group's network associations
1 property 1 required
LocalDateTime
string
AddSpecialtyItem1
object
3 properties 1 required
GroupPractitionerAssociationResponse
object
Response for a practitioner-group association
3 properties
LocationContact1
object
7 properties 2 required
LocalDate
string
UpdateGroupNetworkRequest
object
Request to update a group's association with a specific network
2 properties 1 required
JsonNode
object
22 properties
TerminateGroupSpecialtyResponse
object
Response after terminating group specialties from network participation
6 properties
CreateGroupRequest
object
Request to create a new group with complete data
13 properties
SpecialtyNotCreated
object
A specialty association that could not be created at this level, with reason and message
3 properties 3 required
LocationSpecialty
object
3 properties 1 required
UpdateGroupLocationRequest
object
Request to update an existing group location
15 properties 1 required
OfficeHours1
object
1 property
GroupLocationNetworkRequest
object
Request to associate a group location with a network
2 properties 1 required
TerminateGroupNetworksRequest
object
Terminate group participation in the given networks and cascade to practitioner/location network rows.
4 properties 2 required
LocationService
object
4 properties 2 required
LocationSpecialty1
object
3 properties 1 required
JsonNodeType
string
UpdateGroupLocationNetworkDatesResponse
object
Response for updating effective dates of group location network associations
2 properties 2 required
GroupPractitionerLocationRequest
object
Request to associate a practitioner with a specific group location
3 properties 1 required
AssociateGroupLocationNetworksRequest
object
Request to associate a group location with one or more networks
1 property 1 required
AssociateGroupPractitionersRequest
object
Request to associate one or more practitioners with a group
1 property 1 required
CredentialingContact
object
Credentialing contact information
5 properties
Contact
object
Contact information
5 properties
GroupLocationUpdateResponse
object
2 properties
TerminateGroupLocationRequest
object
Request to terminate a group location
5 properties 2 required
GroupNetworkUpdateResponse
object
Response containing updated group-network associations
2 properties
Contact1
object
Contact information
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

certifyos-group-api-openapi.yml Raw ↑

Other APIs Certifyos publishes across the network.

Certifyos Address Standardization API
Certifyos Auth API
Certifyos Auth Tokens API
Certifyos Contracts API
Certifyos Credentialing Outreach Resource API
Certifyos Credentialing Workflows API
Certifyos Credentialing Workflow API
Certifyos Dal Reactive Test Resource API
Certifyos Directory API
Certifyos Egress Template API
Certifyos Event Email Settings API
Certifyos Facility API
Where this information came from

This is an independent, third-party profile of Certifyos Group API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.