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 Contacts API

An organization's donors and supporters.

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

Tagged areas include Contacts. 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 Contacts 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.

Contacts 2

An organization's donors and supporters.

GET
/contacts
List contacts
listContacts 2 params → 200401429
GET
/contacts/{id}
Get a contact
getContact 1 param → 200401429

Schemas 2

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

ContactList
object
3 properties
Contact
object
A donor or supporter. Field set is modeled.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeffy-contacts-api-openapi.yml Raw ↑

Other APIs Zeffy publishes across the network.

Zeffy Webhooks
Zeffy Campaigns API
Zeffy Payments API