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

Qgiv Recurring API

Confirmed. Read-only reporting on recurring donation schedules.

Qgiv Recurring API is one of 10 APIs that Qgiv publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 3 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://secure.qgiv.com/admin/api.

3 operations 3 paths 3 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://secure.qgiv.com/admin/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Qgiv Recurring API declares 1 security scheme for authenticating requests. An API key is passed in the query as token (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Documented as a POST body field (token= ), not a header or querystring value. Modeled here as an apiKey scheme because OpenAPI 3.0 has no first-class "form fie…

Paths & Operations 3

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

Recurring 3

Confirmed. Read-only reporting on recurring donation schedules.

POST
/reporting/recurring/list
List all recurring transactions (Confirmed)
listRecurringTransactions body → 200401
POST
/reporting/recurring/{status}
List recurring transactions by status (Confirmed)
listRecurringTransactionsByStatus 1 param body → 200401
POST
/reporting/recurring/{id}
Get a single recurring transaction (Confirmed)
getRecurringTransaction 1 param body → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are RecurringTransaction (8 properties), Error (1 property), TokenOnlyRequest (1 property). Each schema is shown below with its type and property counts.

TokenOnlyRequest
object
1 property 1 required
RecurringTransaction
object
8 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qgiv-recurring-api-openapi.yml Raw ↑

Other APIs Qgiv publishes across the network.

Qgiv Account Settings API
Qgiv Custom Amounts API
Qgiv Custom Fields API
Qgiv Events API
Qgiv Mappings API
Qgiv Refunds API
Qgiv Registrations API
Qgiv Statements API
Qgiv Transactions API