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

Zeffy Campaigns API

Donation forms, events, and other campaign types.

Zeffy Campaigns API is one of 4 APIs that Zeffy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://api.zeffy.com/api/v1.

2 operations 2 paths 2 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.zeffy.com/api/v1
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Zeffy Campaigns API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Per-organization API key generated under Settings then Integrations, sent as "Authorization: Bearer YOURAPIKEY".

Paths & Operations 2

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

Campaigns 2

Donation forms, events, and other campaign types.

GET
/campaigns
List campaigns
listCampaigns 1 param → 200401429
GET
/campaigns/{id}
Get a campaign
getCampaign 1 param → 200401429

Schemas 2

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

Campaign
object
A donation form, event, or other campaign type. Field set is modeled.
8 properties
CampaignList
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeffy-campaigns-api-openapi.yml Raw ↑

Other APIs Zeffy publishes across the network.

Zeffy Webhooks
Zeffy Contacts API
Zeffy Payments API