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

The Group Disconnections API from Noyo — 9 operation(s) for group disconnections.

Documentation Provider Profile APIs.io OpenAPI GitHub

Noyo Group Disconnections 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 Disconnections. The published artifact set on APIs.io includes an OpenAPI specification.

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

10 operations 9 paths 9 schemas 6 GET1 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 10

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

Group Disconnections 10
GET
/api/v1/group_disconnection_requests
List Group Disconnection Requests
getGroupDisconnectionRequestList 10 params → 200
POST
/api/v1/group_disconnection_requests
Create a new Group Disconnection Request
createNewGroupDisconnectionRequest body → 201403
GET
/api/v1/group_disconnection_requests/{group_disconnection_request_id}
Get an existing group offboarding request by id
getGroupDisconnectionRequestById 1 param → 201
PUT
/api/v1/group_disconnection_requests/{group_disconnection_request_id}/confirm
Confirm Group Disconnection
confirmGroupDisconnectionRequest 1 param body → 200
PUT
/api/v1/group_disconnection_requests/{group_disconnection_request_id}/reject
Reject Group Disconnection
rejectGroupDisconnectionRequest 1 param → 200
PUT
/api/v1/group_disconnection_requests/{group_disconnection_request_id}/{version}
Edit an existing Group Disconnection Request
editGroupDisconnectionRequest 2 params body → 200
GET
/api/v1/groups/{group_id}/group_disconnection_requests
List Group Disconnection Requests by Group
getGroupDisconnectionRequestListByGroup 3 params → 200
GET
/api/v1/{group_id}/group_disconnection_requests
List Group Disconnection Request by Group (Deprecated Endpoint)
getGroupDisconnectionRequestListByGroupDeprecated 3 params → 200
GET
/ui/v1/group_disconnection_requests
List Group Disconnection Requests
getUIGroupDisconnectionRequestList 11 params → 200
GET
/ui/v1/group_disconnection_requests/{group_disconnection_request_id}
Get an existing group offboarding request by id
getUIGroupDisconnectionRequestById 1 param → 201

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are UIGroupDisconnectionRequestResult (17 properties), GroupDisconnectionRequestResult (15 properties), GroupDisconnectionRequestPublicCreateRequest (5 properties), UIGroupDisconnectionRequestNestedReason (5 properties). Each schema is shown below with its type and property counts.

GroupDisconnectionRequestPublicConfirmRequest
object
1 property
UIGroupDisconnectionRequestNestedReason
object
5 properties 1 required
GroupDisconnectionRequestPublicCreateRequest
object
5 properties 3 required
UIPaginatedGroupDisconnectionRequestResult
object
2 properties 2 required
GroupDisconnectionRequestPublicEditRequest
object
4 properties 1 required
PaginatedGroupDisconnectionRequestResult
object
2 properties 2 required
Meta
object
4 properties 3 required
UIGroupDisconnectionRequestResult
object
17 properties 10 required
GroupDisconnectionRequestResult
object
15 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

noyo-group-disconnections-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 Disconnections
← Back to N APIs
API Details
ID
noyo:noyo-group-disconnections-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