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

Zwapgrid API

Zwapgrid API as documented publicly: 22 operations. Contract generated from the documentation by API Evangelist (2026-10-19); not the provider's own document.

Zwapgrid API is published by Zwapgrid on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

The published artifact set on APIs.io includes an OpenAPI specification and 5 JSON Schemas.

This API exposes 22 operations across 19 paths, organized into 8 resource areas, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 2026-10-19.

Requests are made against a single base URL, https://apione.zwapgrid.com.

22 operations 19 paths 5 schemas 1 DELETE18 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2026-10-19
Base URL
https://apione.zwapgrid.com
Authentication
API Key
Resource Areas
8

Authentication & Security 1

Zwapgrid API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (API_Key). By default, every request must be authenticated.

Paths & Operations 22

Across 19 paths, the API surfaces 22 operations — 1 DELETE, 18 GET, 1 PATCH, 2 POST. They span 8 resource areas: Accountbalances, Api, Client Portal, Consents, Deprecation Schedule, Resources, Security, Trialbalances. Each is listed below with its method, path, parameters, and response codes.

Accountbalances 1
GET
/accountBalances
Removal of accountBalances endpoint
get_accountBalances → 200
Api 3
GET
/api.1/api.1.md
Overview
get_api_1_api_1_md 2 params → 200
GET
/api.1/use-cases.md
Use Cases
get_api_1_use_cases_md 2 params → 200
GET
/api.1/use-cases/invoicing.md
Invoicing
get_api_1_use_cases_invoicing_md 2 params → 200
Client Portal 7
GET
/client-portal/api-keys.md
Perform an HTTP GET request on the following URL with the ask and goal query parameters
get_client_portal_api_keys_md 2 params → 200
GET
/client-portal/api-keys/api-key-lifecycle.md
API Key Lifecycle
get_client_portal_api_keys_api_key_lifecycle_md 2 params → 200
GET
/client-portal/consents.md
Consents
get_client_portal_consents_md 2 params → 200
GET
/client-portal/onboarding.md
Perform an HTTP GET request on the following URL with the ask and goal query parameters
get_client_portal_onboarding_md 2 params → 200
GET
/client-portal/systems.md
Systems
get_client_portal_systems_md 2 params → 200
GET
/client-portal/systems/client-managed-connection.md
Client-managed Connection
get_client_portal_systems_client_managed_connection_md → 200
GET
/client-portal/users.md
You can manage who has access to the Client Portal for your organisation.
get_client_portal_users_md 2 params → 200
Consents 6
GET
/consents/api/v1/consents
List consents
get_consents_api_v1_consents 12 params → 200
POST
/consents/api/v1/consents
Create a consent
post_consents_api_v1_consents 2 params body → 201
DELETE
/consents/api/v1/consents/{consentid}
Delete a consent
delete_consents_api_v1_consents_consentid 3 params → 204
GET
/consents/api/v1/consents/{consentid}
Get a consent
get_consents_api_v1_consents_consentid 3 params → 200
PATCH
/consents/api/v1/consents/{consentid}
Update a consent
patch_consents_api_v1_consents_consentid 4 params body → 204
POST
/consents/api/v1/consents/{consentid}/otc
Create a one-time code
post_consents_api_v1_consents_consentid_otc 3 params → 201
Deprecation Schedule 1
GET
/deprecation-schedule/2025-01/deprecation-of-accountbalances-endpoint.md
Deprecation of accountbalances endpoint
get_deprecation_schedule_2025_01_deprecation_of_accountbalances_endpoint_md → 200
Resources 2
GET
/resources/demos.md
Demos
get_resources_demos_md 2 params → 200
GET
/resources/postman.md
Postman
get_resources_postman_md 2 params → 200
Security 1
GET
/security/api-security.md
API Security
get_security_api_security_md 2 params → 200
Trialbalances 1
GET
/trialBalances
Removal of accountBalances endpoint
get_trialBalances → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are GetConsentsApiV1ConsentsConsentidResponse (8 properties), PatchConsentsApiV1ConsentsConsentidRequest (2 properties), PostConsentsApiV1ConsentsRequest (2 properties), GetConsentsApiV1ConsentsResponse (2 properties). Each schema is shown below with its type and property counts.

GetConsentsApiV1ConsentsResponse
object
2 properties
PostConsentsApiV1ConsentsRequest
object
2 properties 1 required
GetConsentsApiV1ConsentsConsentidResponse
object
8 properties
PatchConsentsApiV1ConsentsConsentidRequest
object
2 properties
PostConsentsApiV1ConsentsConsentidOtcResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zwapgrid-openapi-generated.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Zwapgrid 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.