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

The Group Connections API from Noyo — 4 operation(s) for group connections.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

6 operations 4 paths 10 schemas 3 GET2 POST1 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 6

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

Group Connections 6
GET
/api/v1/group_connections
List Group Connections
getGroupConnectionRequestList 10 params → 200
POST
/api/v1/group_connections
Create a new Group Connection
createGroupConnection body → 201
GET
/api/v1/group_connections/{connection_id}
Get a single Group Connection
getGroupConnection 1 param → 200
PUT
/api/v1/group_connections/{connection_id}/retry
Retry an existing group connection for an existing group
retryGroupConnectionWithExistingGroup 1 param body → 201
GET
/api/v1/groups/{group_id}/group_connections
List Group Connections by Group
getGroupConnectionRequestListByGroup 6 params → 200
POST
/api/v1/groups/{group_id}/group_connections
Create a new group connection in an existing group
createGroupConnectionWithExistingGroup 1 param body → 201

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are GroupSetupRequestPublicResult (13 properties), GroupSetupRequestResult (12 properties), GroupSetupRequestPublicGroupDataResult (5 properties), GroupSetupRequestPublicGroupData (5 properties). Each schema is shown below with its type and property counts.

GroupSetupRequestPublicNestedGroupData
object
4 properties 1 required
GroupSetupRequestPublicAPICreateRequest
object
5 properties 2 required
GroupSetupRequestPublicGroupDataResult
object
5 properties 2 required
GroupSetupRequestPublicResult
object
13 properties 11 required
Meta
object
4 properties 3 required
GroupSetupRequestPublicAPINestedCreateRequest
object
4 properties 2 required
GroupSetupRequestPublicAPIRetryRequest
object
5 properties
GroupSetupRequestPublicGroupData
object
5 properties 2 required
GroupSetupRequestResult
object
12 properties 12 required
PaginatedGroupSetupRequestPublicResult
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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