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 Platform Account Structure API

The Platform Account Structure API from Noyo — 3 operation(s) for platform account structure.

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

Tagged areas include Platform Account Structure. The published artifact set on APIs.io includes an OpenAPI specification.

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

4 operations 3 paths 6 schemas 2 GET1 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 4

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

Platform Account Structure 4
GET
/api/v1/groups/{group_id}/platform_account_structures
Get a Platform Account Structure by Group
getPlatformAccountStructureByGroup 2 params → 200
POST
/api/v1/groups/{group_id}/platform_account_structures
Create a new Platform Account Structure
createNewPlatformAccountStructure 1 param body → 201
GET
/api/v1/platform_account_structures/{platform_account_structure_id}
Get a single Platform Account Structure
getPlatformAccountStructure 2 params → 200
PUT
/api/v1/platform_account_structures/{platform_account_structure_id}/{version}
Edit an existing Platform Account Structure
editPlatformAccountStructure 3 params body → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PlatformAccountStructureAccountStructurePlan (14 properties), PlatformAccountStructureResult (6 properties), PlatformAccountStructureEditRequest (4 properties), PlatformAccountStructureAccountStructureField (3 properties). Each schema is shown below with its type and property counts.

PlatformAccountStructureEditRequest
object
4 properties 1 required
PlatformAccountStructureCreateRequest
object
3 properties 1 required
PlatformAccountStructureResult
object
6 properties 6 required
PlatformAccountStructureAccountStructureField
object
3 properties 3 required
PlatformAccountStructureAccountStructurePlan
object
14 properties
PlatformAccountStructureAccountStructure
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

noyo-platform-account-structure-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