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 Custom Fields API

Confirmed. Manage custom fields on a donation form.

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

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

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

4 operations 3 paths 4 schemas 1 GET3 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 Custom Fields 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 4

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

Custom Fields 4

Confirmed. Manage custom fields on a donation form.

POST
/customFields/list
List all custom fields (Confirmed)
listCustomFields body → 200401
POST
/customFields/create
Create a custom field (Confirmed)
createCustomField body → 200401422
GET
/customFields/{id}
Retrieve a single custom field (Confirmed)
getCustomField 1 param body → 200401404
POST
/customFields/{id}
Update a custom field (Confirmed)
updateCustomField 1 param body → 200401404422

Schemas 4

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

PackageRequest
object
2 properties 2 required
TokenOnlyRequest
object
1 property 1 required
CustomField
object
14 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qgiv-custom-fields-api-openapi.yml Raw ↑

Other APIs Qgiv publishes across the network.

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